Browse Source

Linting README.md Markdown

pull/832/head
Kantanat Wannapaka 3 years ago
parent
commit
2259b947ab
  1. 18
      README.md

18
README.md

@ -15,7 +15,7 @@ __[Live demo](https://markdown-it.github.io)__
- [Safe](https://github.com/markdown-it/markdown-it/tree/master/docs/security.md) by default. - [Safe](https://github.com/markdown-it/markdown-it/tree/master/docs/security.md) by default.
- Community-written __[plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin)__ and [other packages](https://www.npmjs.org/browse/keyword/markdown-it) on npm. - Community-written __[plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin)__ and [other packages](https://www.npmjs.org/browse/keyword/markdown-it) on npm.
__Table of content__ ## Table of content
- [Install](#install) - [Install](#install)
- [Usage examples](#usage-examples) - [Usage examples](#usage-examples)
@ -45,7 +45,6 @@ npm install markdown-it --save
- [jsDeliver CDN](http://www.jsdelivr.com/#!markdown-it "jsDelivr CDN") - [jsDeliver CDN](http://www.jsdelivr.com/#!markdown-it "jsDelivr CDN")
- [cdnjs.com CDN](https://cdnjs.com/libraries/markdown-it "cdnjs.com") - [cdnjs.com CDN](https://cdnjs.com/libraries/markdown-it "cdnjs.com")
## Usage examples ## Usage examples
See also: See also:
@ -55,7 +54,6 @@ See also:
- [Development info](https://github.com/markdown-it/markdown-it/tree/master/docs) - - [Development info](https://github.com/markdown-it/markdown-it/tree/master/docs) -
for plugins writers. for plugins writers.
### Simple ### Simple
```js ```js
@ -81,7 +79,6 @@ var md = require('markdown-it')();
var result = md.renderInline('__markdown-it__ rulezz!'); var result = md.renderInline('__markdown-it__ rulezz!');
``` ```
### Init with presets and options ### Init with presets and options
(*) presets define combinations of active rules and options. Can be (*) presets define combinations of active rules and options. Can be
@ -139,7 +136,6 @@ var md = require('markdown-it')()
.use(plugin3); .use(plugin3);
``` ```
### Syntax highlighting ### Syntax highlighting
Apply syntax highlighting to fenced code blocks with the `highlight` option: Apply syntax highlighting to fenced code blocks with the `highlight` option:
@ -191,7 +187,6 @@ configure linkify-it, access the linkify instance through `md.linkify`:
md.linkify.set({ fuzzyEmail: false }); // disables converting email to link md.linkify.set({ fuzzyEmail: false }); // disables converting email to link
``` ```
## API ## API
__[API documentation](https://markdown-it.github.io/markdown-it/)__ __[API documentation](https://markdown-it.github.io/markdown-it/)__
@ -199,7 +194,6 @@ __[API documentation](https://markdown-it.github.io/markdown-it/)__
If you are going to write plugins - take a look at If you are going to write plugins - take a look at
[Development info](https://github.com/markdown-it/markdown-it/tree/master/docs). [Development info](https://github.com/markdown-it/markdown-it/tree/master/docs).
## Syntax extensions ## Syntax extensions
Embedded (enabled by default): Embedded (enabled by default):
@ -220,7 +214,6 @@ Via plugins:
- [mark](https://github.com/markdown-it/markdown-it-mark) - [mark](https://github.com/markdown-it/markdown-it-mark)
- ... and [others](https://www.npmjs.org/browse/keyword/markdown-it-plugin) - ... and [others](https://www.npmjs.org/browse/keyword/markdown-it-plugin)
### Manage rules ### Manage rules
By default all rules are enabled, but can be restricted by options. On plugin By default all rules are enabled, but can be restricted by options. On plugin
@ -245,7 +238,6 @@ You can find all rules in sources:
[parser_core.js](lib/parser_core.js), [parser_block](lib/parser_block.js), [parser_core.js](lib/parser_core.js), [parser_block](lib/parser_block.js),
[parser_inline](lib/parser_inline.js). [parser_inline](lib/parser_inline.js).
## Benchmark ## Benchmark
Here is the result of readme parse at MB Pro Retina 2013 (2.4 GHz): Here is the result of readme parse at MB Pro Retina 2013 (2.4 GHz):
@ -271,14 +263,12 @@ As you can see, `markdown-it` doesn't pay with speed for it's flexibility.
Slowdown of "full" version caused by additional features not available in Slowdown of "full" version caused by additional features not available in
other implementations. other implementations.
## markdown-it for enterprise ## markdown-it for enterprise
Available as part of the Tidelift Subscription. Available as part of the Tidelift Subscription.
The maintainers of `markdown-it` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-markdown-it?utm_source=npm-markdown-it&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) The maintainers of `markdown-it` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-markdown-it?utm_source=npm-markdown-it&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
## Authors ## Authors
- Alex Kocharin [github/rlidwka](https://github.com/rlidwka) - Alex Kocharin [github/rlidwka](https://github.com/rlidwka)
@ -296,12 +286,12 @@ during this project's development.
**Related Links:** **Related Links:**
- https://github.com/jgm/CommonMark - reference CommonMark implementations in C & JS, - <https://github.com/jgm/CommonMark> - reference CommonMark implementations in C & JS,
also contains latest spec & online demo. also contains latest spec & online demo.
- http://talk.commonmark.org - CommonMark forum, good place to collaborate - <http://talk.commonmark.org> - CommonMark forum, good place to collaborate
developers' efforts. developers' efforts.
**Ports** ## Ports
- [motion-markdown-it](https://github.com/digitalmoksha/motion-markdown-it) - Ruby/RubyMotion - [motion-markdown-it](https://github.com/digitalmoksha/motion-markdown-it) - Ruby/RubyMotion
- [markdown-it-py](https://github.com/ExecutableBookProject/markdown-it-py)- Python - [markdown-it-py](https://github.com/ExecutableBookProject/markdown-it-py)- Python

Loading…
Cancel
Save