From 3e681a695c3a42787bdf64795fba262a82c0c017 Mon Sep 17 00:00:00 2001 From: Steven Date: Sun, 11 Mar 2018 17:32:23 -0400 Subject: [PATCH] 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 - +