Skip to content

Commit f17f55f

Browse files
UziTechstyfle
andauthored
chore(docs): update versioning and other docs (#1834)
Co-authored-by: Steven <[email protected]>
1 parent e6515ca commit f17f55f

File tree

5 files changed

+22
-16
lines changed

5 files changed

+22
-16
lines changed

LICENSE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ all code is your original work. `</legalese>`
88

99
## Marked
1010

11+
Copyright (c) 2018+, MarkedJS (https://github.com/markedjs/)
1112
Copyright (c) 2011-2018, Christopher Jeffrey (https://github.com/chjj/)
1213

1314
Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -30,8 +31,8 @@ THE SOFTWARE.
3031

3132
## Markdown
3233

33-
Copyright © 2004, John Gruber
34-
http://daringfireball.net/
34+
Copyright © 2004, John Gruber
35+
http://daringfireball.net/
3536
All rights reserved.
3637

3738
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
[![gzip size](https://badgen.net/badgesize/gzip/https://cdn.jsdelivr.net/npm/marked/marked.min.js)](https://cdn.jsdelivr.net/npm/marked/marked.min.js)
99
[![install size](https://badgen.net/packagephobia/install/marked)](https://packagephobia.now.sh/result?p=marked)
1010
[![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked)
11-
[![dep](https://badgen.net/david/dep/markedjs/marked?label=deps)](https://david-dm.org/markedjs/marked)
12-
[![dev dep](https://badgen.net/david/dev/markedjs/marked?label=devDeps)](https://david-dm.org/markedjs/marked?type=dev)
1311
[![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions)
1412
[![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked)
1513

docs/AUTHORS.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,20 @@ Marked takes an encompassing approach to its community. As such, you can think o
5353
<small>Release Wrangler; Titan of the test harness; Dr. DevOps</small>
5454
</td>
5555
<td align="center" valign="top">
56-
&nbsp;
56+
<a href="https://github.com/calculuschild">
57+
<img width="100" height="100" src="https://github.com/calculuschild.png?s=150">
58+
</a>
59+
<br>
60+
<a href="https://github.com/calculuschild">Trevor Buckner</a>
61+
<div>Committer</div>
62+
<small>Master of Marked</small>
5763
</td>
5864
</tr>
5965
</tbody>
6066
</table>
6167

68+
## Contributors
69+
6270
<table>
6371
<tbody>
6472
<tr>

docs/PUBLISHING.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,8 @@ Marked uses [semantic-release](https://github.com/semantic-release/semantic-rele
88

99
## Versioning
1010

11-
We follow [semantic versioning](https://semver.org) where the following sequence is true `[major].[minor].[patch]`; therefore, consider the following implications of the release you are preparing:
11+
We follow [semantic versioning](https://semver.org) where the following sequence is true `[major].[minor].[patch]`:
1212

13-
1. **Major:** There is at least one change not deemed backward compatible.
14-
2. **Minor:** There is at least one new feature added to the release.
15-
3. **Patch:** No breaking changes, no new features.
16-
17-
What to expect while Marked is a zero-major (0.x.y):
18-
19-
1. The major will remain at zero; thereby, alerting consumers to the potentially volatile nature of the package.
20-
2. The minor will tend to be more analogous to a `major` release.
21-
3. The patch will tend to be more analogous to a `minor` release or a collection of bug fixes (patches).
13+
1. **Major:** There is at least one change to the public API or a break from the [CommonMark](https://spec.commonmark.org/current/) or [GFM](https://github.github.com/gfm/) spec.
14+
2. **Minor:** There is at least one new feature added to the public API.
15+
3. **Patch:** Changes that move Marked closer to spec compliance or change a public API that does not break backwards compatibility.

docs/_document.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,12 @@ <h1>Marked Documentation</h1>
6464
</li>
6565
<li><a href="/code_of_conduct">Code of Conduct</a></li>
6666
<li><a href="/authors">Authors</a></li>
67-
<li><a href="/publishing">Publishing</a></li>
67+
<li>
68+
<a href="/publishing">Publishing</a>
69+
<ul>
70+
<li><a href="/publishing#versioning">Versioning</a></li>
71+
</ul>
72+
</li>
6873
<li><a href="/license">License</a></li>
6974
</ul>
7075
</nav>

0 commit comments

Comments
 (0)