From 2509660bb9eacba46b432d728392496b0a3198c7 Mon Sep 17 00:00:00 2001 From: Steven Date: Sun, 11 Mar 2018 17:06:03 -0400 Subject: [PATCH 1/5] Rename doc to docs --- doc/todo.md | 2 -- {doc => docs}/broken.md | 0 2 files changed, 2 deletions(-) delete mode 100644 doc/todo.md rename {doc => docs}/broken.md (100%) diff --git a/doc/todo.md b/doc/todo.md deleted file mode 100644 index 2e60b162ae..0000000000 --- a/doc/todo.md +++ /dev/null @@ -1,2 +0,0 @@ -# Todo - diff --git a/doc/broken.md b/docs/broken.md similarity index 100% rename from doc/broken.md rename to docs/broken.md From 94b8b3e1b168ce0b4369043997eace9a80ff87a9 Mon Sep 17 00:00:00 2001 From: Steven Date: Sun, 11 Mar 2018 17:16:48 -0400 Subject: [PATCH 2/5] Move existing docs to /docs dir --- .github/PULL_REQUEST_TEMPLATE/release.md | 2 +- .npmignore | 1 + README.md | 12 +-- AUTHORS.md => docs/AUTHORS.md | 0 CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md => docs/CONTRIBUTING.md | 8 +- docs/HOME.md | 99 +++++++++++++++++++ PUBLISHING.md => docs/PUBLISHING.md | 2 +- USING_ADVANCED.md => docs/USING_ADVANCED.md | 0 USING_PRO.md => docs/USING_PRO.md | 0 10 files changed, 113 insertions(+), 13 deletions(-) rename AUTHORS.md => docs/AUTHORS.md (100%) rename CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md (96%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (85%) create mode 100644 docs/HOME.md rename PUBLISHING.md => docs/PUBLISHING.md (94%) rename USING_ADVANCED.md => docs/USING_ADVANCED.md (100%) rename USING_PRO.md => docs/USING_PRO.md (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index e297751786..d2183990c8 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -19,7 +19,7 @@ Note: If merges to `master` occur after submitting this PR and before running `$ In most cases, this should be someone different than the publisher. -- [ ] Version in `package.json` has been updated (see [RELEASE.md](https://github.com/markedjs/marked/blob/master/RELEASE.md)). +- [ ] Version in `package.json` has been updated (see [RELEASE.md](https://github.com/markedjs/marked/blob/master/docs/RELEASE.md)). - [ ] The `marked.min.js` has been updated; or, - [ ] release does not change library. - [ ] cm_autolinks is the only failing test (remove once CI is in place and all tests pass). diff --git a/.npmignore b/.npmignore index 3fb773c034..029b92609d 100644 --- a/.npmignore +++ b/.npmignore @@ -1,2 +1,3 @@ .git* test/ +docs \ No newline at end of file diff --git a/README.md b/README.md index 96ee203bad..d6146f11dc 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ $ cat hello.html ``` -Marked offers [advanced configurations](https://github.com/markedjs/marked/blob/master/USING_ADVANCED.md) and [extensibility](https://github.com/markedjs/marked/blob/master/USING_PRO.md) as well. +Marked offers [advanced configurations](https://github.com/markedjs/marked/blob/master/docs/USING_ADVANCED.md) and [extensibility](https://github.com/markedjs/marked/blob/master/docs/USING_PRO.md) as well.

Supported Markdown specifications

@@ -79,21 +79,21 @@ By supporting the above Markdown flavors, it's possible that Marked can help you The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously. -Therefore, please disclose potential security issues by email to the project [committers](https://github.com/markedjs/marked/blob/master/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue). +Therefore, please disclose potential security issues by email to the project [committers](https://github.com/markedjs/marked/blob/master/docs/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).

Contributing

-The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](https://github.com/markedjs/marked/blob/master/CONTRIBUTING.md) for more details. +The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](https://github.com/markedjs/marked/blob/master/docs/CONTRIBUTING.md) for more details. -For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md). +For our Contribution License Agreement, see our [license](LICENSE.md).

Authors

-For list of credited authors and contributors, please see our [authors page](https://github.com/markedjs/marked/blob/master/AUTHORS.md). +For list of credited authors and contributors, please see our [authors page](https://github.com/markedjs/marked/blob/master/docs/AUTHORS.md).

License

Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) -See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details. +See [license](LICENSE.md) for more details. diff --git a/AUTHORS.md b/docs/AUTHORS.md similarity index 100% rename from AUTHORS.md rename to docs/AUTHORS.md diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 96% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md index 3fe8c89a80..077c0fc708 100644 --- a/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team by submitting a PR with changes to the [AUTHORS](https://github.com/markedjs/marked/blob/master/AUTHORS.md) page (or emailing josh@8fold.com). All +reported by contacting the project team by submitting a PR with changes to the [AUTHORS](AUTHORS.md) page (or emailing josh@8fold.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 85% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index 9fbb49500b..d2198554e7 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -25,15 +25,15 @@ The following table lists the ticket type labels we use when there is work to be |Ticket type label |Description | |:----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------| |L0 - security |A security vulnerability within the Marked library is discovered. | -|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](https://github.com/markedjs/marked/blob/master/AUTHORS.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. | +|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](AUTHORS.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. | |L2 - annoying |Similar to L1 - broken only there is a known workaround avaialable for the issue. | |RR - refactor and re-engineer |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both. | -|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](https://github.com/markedjs/marked/blob/master/AUTHORS.md#specifications)| +|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](AUTHORS.md#specifications)| |NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. | ## Test early, often, and everything -We try to write test cases to validate output (writing tests based on the [supported specifications](https://github.com/markedjs/marked/blob/master/AUTHORS.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness. +We try to write test cases to validate output (writing tests based on the [supported specifications](AUTHORS.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness. |Location |Description | |:-------------|:---------------------------------------------------| @@ -92,4 +92,4 @@ npm run build ## Publishing -Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](https://github.com/markedjs/marked/blob/master/PUBLISHING.md). +Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](PUBLISHING.md). diff --git a/docs/HOME.md b/docs/HOME.md new file mode 100644 index 0000000000..1f677ac21d --- /dev/null +++ b/docs/HOME.md @@ -0,0 +1,99 @@ + + +

Marked

+ +Marked is + +1. built for speed.* +2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.** +3. light-weight while implementing all markdown features from the supported flavors & specifications.*** +4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects. + +

* Still working on metrics for comparative analysis and definition.
+** As few dependencies as possible.
+*** Strict compliance could result in slower processing when running comparative benchmarking.

+ +

Installation

+ +**CLI:** `npm install -g marked` + +**In-browser:** `npm install marked --save` + +

Usage

+ +**CLI** + +``` bash +$ marked -o hello.html +hello world +^D +$ cat hello.html +

hello world

+``` + +**Browser** + +```html + + + + + Marked in the browser + + + +
+ + + +``` + + +Marked offers [advanced configurations](USING_ADVANCED.md) and [extensibility](USING_PRO.md) as well. + +

Supported Markdown specifications

+ +We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors). + +|Flavor |Version | +|:----------------------------------------------------------|:----------| +|The original markdown.pl |-- | +|[CommonMark](http://spec.commonmark.org/0.28/) |0.28 | +|[GitHub Flavored Markdown](https://github.github.com/gfm/) |0.28 | + +By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community. + +

Security

+ +The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously. + +Therefore, please disclose potential security issues by email to the project [committers](AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue). + +

Contributing

+ +The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](CONTRIBUTING.md) for more details. + +For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md). + +

Authors

+ +For list of credited authors and contributors, please see our [authors page](AUTHORS.md). + +

License

+ +Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) + +See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details. + diff --git a/PUBLISHING.md b/docs/PUBLISHING.md similarity index 94% rename from PUBLISHING.md rename to docs/PUBLISHING.md index 82a45d4bd3..4732fdf748 100644 --- a/PUBLISHING.md +++ b/docs/PUBLISHING.md @@ -1,6 +1,6 @@ # Releasing Marked -- [ ] See [contributing](https://github.com/markedjs/marked/blob/master/CONTRIBUTING.md) +- [ ] See [contributing](CONTRIBUTING.md) - [ ] Create release branch from `master` (`release-x.y.z`) - [ ] Submit PR with minimal name: Release x.y.z - [ ] Complete PR checklists diff --git a/USING_ADVANCED.md b/docs/USING_ADVANCED.md similarity index 100% rename from USING_ADVANCED.md rename to docs/USING_ADVANCED.md diff --git a/USING_PRO.md b/docs/USING_PRO.md similarity index 100% rename from USING_PRO.md rename to docs/USING_PRO.md From 3e681a695c3a42787bdf64795fba262a82c0c017 Mon Sep 17 00:00:00 2001 From: Steven Date: Sun, 11 Mar 2018 17:32:23 -0400 Subject: [PATCH 3/5] Move most of README.md to /docs/README.md --- README.md | 64 ++++++------------------------------- docs/{HOME.md => README.md} | 2 +- 2 files changed, 10 insertions(+), 56 deletions(-) rename docs/{HOME.md => README.md} (98%) diff --git a/README.md b/README.md index d6146f11dc..57f720749c 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,19 @@ - - -

Marked

+# Marked Marked is -1. built for speed.* -2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.** -3. light-weight while implementing all markdown features from the supported flavors & specifications.*** +1. built for speed. +2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time. +3. light-weight while implementing all markdown features from the supported flavors & specifications. 4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects. -

* Still working on metrics for comparative analysis and definition.
-** As few dependencies as possible.
-*** Strict compliance could result in slower processing when running comparative benchmarking.

- -

Installation

+## Installation **CLI:** `npm install -g marked` **In-browser:** `npm install marked --save` -

Usage

+## Usage **CLI** @@ -48,52 +33,21 @@ $ cat hello.html Marked in the browser - +
``` -Marked offers [advanced configurations](https://github.com/markedjs/marked/blob/master/docs/USING_ADVANCED.md) and [extensibility](https://github.com/markedjs/marked/blob/master/docs/USING_PRO.md) as well. - -

Supported Markdown specifications

- -We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors). - -|Flavor |Version | -|:----------------------------------------------------------|:----------| -|The original markdown.pl |-- | -|[CommonMark](http://spec.commonmark.org/0.28/) |0.28 | -|[GitHub Flavored Markdown](https://github.github.com/gfm/) |0.28 | - -By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community. - -

Security

- -The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously. -Therefore, please disclose potential security issues by email to the project [committers](https://github.com/markedjs/marked/blob/master/docs/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue). - -

Contributing

- -The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](https://github.com/markedjs/marked/blob/master/docs/CONTRIBUTING.md) for more details. - -For our Contribution License Agreement, see our [license](LICENSE.md). - -

Authors

- -For list of credited authors and contributors, please see our [authors page](https://github.com/markedjs/marked/blob/master/docs/AUTHORS.md). - -

License

+## License Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) -See [license](LICENSE.md) for more details. - diff --git a/docs/HOME.md b/docs/README.md similarity index 98% rename from docs/HOME.md rename to docs/README.md index 1f677ac21d..95dacd51d2 100644 --- a/docs/HOME.md +++ b/docs/README.md @@ -48,7 +48,7 @@ $ cat hello.html Marked in the browser - +
From 35214c58a68cc02e3d8458fd1223d82e6c6981d1 Mon Sep 17 00:00:00 2001 From: Steven Date: Sun, 11 Mar 2018 18:43:26 -0400 Subject: [PATCH 4/5] Add initial docs with logo --- docs/img/logo-black-and-white.svg | 133 ++++++++++++++++++++++++++++++ docs/img/logo-black.svg | 32 +++++++ docs/index.html | 107 ++++++++++++++++++++++++ 3 files changed, 272 insertions(+) create mode 100644 docs/img/logo-black-and-white.svg create mode 100644 docs/img/logo-black.svg create mode 100644 docs/index.html diff --git a/docs/img/logo-black-and-white.svg b/docs/img/logo-black-and-white.svg new file mode 100644 index 0000000000..5f6c0b781b --- /dev/null +++ b/docs/img/logo-black-and-white.svg @@ -0,0 +1,133 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/img/logo-black.svg b/docs/img/logo-black.svg new file mode 100644 index 0000000000..a67fb80e5f --- /dev/null +++ b/docs/img/logo-black.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000000..5be5946857 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,107 @@ + + + + + Marked.js Documentation + + + +
+
+ +

Marked.js Documentation

+
+ +
+
+ + + + + + \ No newline at end of file From c22be25663d64c408926bd9d62d179c6acbf8578 Mon Sep 17 00:00:00 2001 From: Steven Date: Tue, 13 Mar 2018 14:54:49 -0400 Subject: [PATCH 5/5] Create CNAME for marked.js.org --- docs/CNAME | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/CNAME diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000000..c92fdfcbd4 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +marked.js.org