From 32e3e682122c2d0656f6758b13cb7abb178cc6e3 Mon Sep 17 00:00:00 2001 From: David Booth Date: Tue, 24 Oct 2017 20:51:03 -0400 Subject: [PATCH 1/4] Added Quick Start section --- .verb.md | 8 +++- README.md | 119 ++++++++++++++++++++++++++++++++++-------------------- 2 files changed, 82 insertions(+), 45 deletions(-) diff --git a/.verb.md b/.verb.md index 758c3ef..089cef7 100644 --- a/.verb.md +++ b/.verb.md @@ -1,3 +1,9 @@ +## Quick Start +Assuming you want to add a TOC to README.md: +1. ```$ npm install -g markdown-toc``` +2. Edit README.md and insert the following line where you want the TOC inserted:
```<-- toc -->``` +3. ```$ markdown-toc -i README.md``` + ## CLI ``` @@ -253,4 +259,4 @@ Type: `Boolean` Default: `true` -Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior. \ No newline at end of file +Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior. diff --git a/README.md b/README.md index b8766c4..dd67631 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ ## Table of Contents -- [Install](#install) -- [CLI](#cli) - [Highlights](#highlights) - [Usage](#usage) - [API](#api) @@ -26,13 +24,24 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ ## Install - Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save markdown-toc ``` +Install with [yarn](https://yarnpkg.com): + +```sh +$ yarn add markdown-toc +``` + +## Quick Start +Assuming you want to add a TOC to README.md: +1. ```$ npm install -g markdown-toc``` +2. Edit README.md and insert the following line where you want the TOC inserted:
```<-- toc -->``` +3. ```$ markdown-toc -i README.md``` + ## CLI ``` @@ -41,7 +50,24 @@ Usage: markdown-toc [options] input: The Markdown file to parse for table of contents, or "-" to read from stdin. - -i: Edit the file directly, injecting the TOC at ; + -i: Edit the file directly, injecting the TOC at - [Highlights](#highlights) +- [Usage](#usage) +- [API](#api) + * [toc.plugin](#tocplugin) + * [toc.json](#tocjson) + * [toc.insert](#tocinsert) + * [Utility functions](#utility-functions) +- [Options](#options) + * [options.append](#optionsappend) + * [options.filter](#optionsfilter) + * [options.slugify](#optionsslugify) + * [options.bullets](#optionsbullets) + * [options.maxdepth](#optionsmaxdepth) + * [options.firsth1](#optionsfirsth1) + * [options.stripHeadingTags](#optionsstripheadingtags) +- [About](#about) + +_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_; (Without this flag, the default is to print the TOC to stdout.) --json: Print the TOC in JSON format @@ -65,18 +91,18 @@ Usage: markdown-toc [options] **Features** -* Can optionally be used as a [remarkable](https://github.com/jonschlinkert/remarkable) plugin -* Returns an object with the rendered TOC (on `content`), as well as a `json` property with the raw TOC object, so you can generate your own TOC using templates or however you want -* Works with [repeated headings](https://gist.github.com/jonschlinkert/ac5d8122bfaaa394f896) -* Uses sane defaults, so no customization is necessary, but you can if you need to. -* [filter](#filter-headings) out headings you don't want -* [Improve](#titleize) the headings you do want -* Use a custom [slugify](#optionsslugify) function to change how links are created +- Can optionally be used as a [remarkable][] plugin +- Returns an object with the rendered TOC (on `content`), as well as a `json` property with the raw TOC object, so you can generate your own TOC using templates or however you want +- Works with [repeated headings](https://gist.github.com/jonschlinkert/ac5d8122bfaaa394f896) +- Uses sane defaults, so no customization is necessary, but you can if you need to. +- [filter](#filter-headings) out headings you don't want +- [Improve](#titleize) the headings you do want +- Use a custom [slugify](#optionsslugify) function to change how links are created **Safe!** -* Won't mangle markdown in code examples in gfm code blocks that other TOC generators mistake as being actual headings (this happens when markdown headings are show in _examples_, meaning they arent' actually headings that should be in the toc. Also happens with yaml and coffee-script comments, or any comments that use `#`) -* Won't mangle front-matter, or mistake front-matter properties for headings like other TOC generators +- Won't mangle markdown in code examples in gfm code blocks that other TOC generators mistake as being actual headings (this happens when markdown headings are show in _examples_, meaning they arent' actually headings that should be in the toc. Also happens with yaml and coffee-script comments, or any comments that use `#`) +- Won't mangle front-matter, or mistake front-matter properties for headings like other TOC generators ## Usage @@ -91,15 +117,15 @@ toc('# One\n\n# Two').content; To allow customization of the output, an object is returned with the following properties: -* `content` **{String}**: The generated table of contents. Unless you want to customize rendering, this is all you need. -* `highest` **{Number}**: The highest level heading found. This is used to adjust indentation. -* `tokens` **{Array}**: Headings tokens that can be used for custom rendering + - `content` **{String}**: The generated table of contents. Unless you want to customize rendering, this is all you need. + - `highest` **{Number}**: The highest level heading found. This is used to adjust indentation. + - `tokens` **{Array}**: Headings tokens that can be used for custom rendering ## API ### toc.plugin -Use as a [remarkable](https://github.com/jonschlinkert/remarkable) plugin. +Use as a [remarkable][] plugin. ```js var Remarkable = require('remarkable'); @@ -128,7 +154,7 @@ Results in: ### toc.json -Object for creating a custom TOC. +Object for creating a custom TOC. ```js toc('# AAA\n## BBB\n### CCC\nfoo').json; @@ -141,7 +167,7 @@ toc('# AAA\n## BBB\n### CCC\nfoo').json; ### toc.insert -Insert a table of contents immediately after an _opening_ `` code comment, or replace an existing TOC if both an _opening_ comment and a _closing_ comment (``) are found. +Insert a table of contents immediately after an _opening_ `` code comment, or replace an existing TOC if both an _opening_ comment and a _closing_ comment (``) are found. _(This strategy works well since code comments in markdown are hidden when viewed as HTML, like when viewing a README on GitHub README for example)._ @@ -183,11 +209,10 @@ As a convenience to folks who wants to create a custom TOC, markdown-toc's inter ```js var toc = require('markdown-toc'); ``` - -* `toc.bullets()`: render a bullet list from an array of tokens -* `toc.linkify()`: linking a heading `content` string -* `toc.slugify()`: slugify a heading `content` string -* `toc.strip()`: strip words or characters from a heading `content` string +- `toc.bullets()`: render a bullet list from an array of tokens +- `toc.linkify()`: linking a heading `content` string +- `toc.slugify()`: slugify a heading `content` string +- `toc.strip()`: strip words or characters from a heading `content` string **Example** @@ -216,15 +241,15 @@ Type: `Function` Default: `undefined` -Params: +Params: -* `str` **{String}** the actual heading string -* `ele` **{Objecct}** object of heading tokens -* `arr` **{Array}** all of the headings objects + - `str` **{String}** the actual heading string + - `ele` **{Objecct}** object of heading tokens + - `arr` **{Array}** all of the headings objects **Example** -From time to time, we might get junk like this in our TOC. +From time to time, we might get junk like this in our TOC. ``` [.aaa([foo], ...) another bad heading](#-aaa--foo--------another-bad-heading) @@ -286,25 +311,23 @@ Default: `true` Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior. ## About - ### Related projects - -* [gfm-code-blocks](https://www.npmjs.com/package/gfm-code-blocks): Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | [homepage](https://github.com/jonschlinkert/gfm-code-blocks "Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.") -* [markdown-link](https://www.npmjs.com/package/markdown-link): Micro util for generating a single markdown link. | [homepage](https://github.com/jonschlinkert/markdown-link "Micro util for generating a single markdown link.") -* [markdown-utils](https://www.npmjs.com/package/markdown-utils): Micro-utils for creating markdown snippets. | [homepage](https://github.com/jonschlinkert/markdown-utils "Micro-utils for creating markdown snippets.") -* [pretty-remarkable](https://www.npmjs.com/package/pretty-remarkable): Plugin for prettifying markdown with Remarkable using custom renderer rules. | [homepage](https://github.com/jonschlinkert/pretty-remarkable "Plugin for prettifying markdown with Remarkable using custom renderer rules.") -* [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable "Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.") +- [gfm-code-blocks](https://www.npmjs.com/package/gfm-code-blocks): Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | [homepage](https://github.com/jonschlinkert/gfm-code-blocks "Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.") +- [markdown-link](https://www.npmjs.com/package/markdown-link): Micro util for generating a single markdown link. | [homepage](https://github.com/jonschlinkert/markdown-link "Micro util for generating a single markdown link.") +- [markdown-utils](https://www.npmjs.com/package/markdown-utils): Micro-utils for creating markdown snippets. | [homepage](https://github.com/jonschlinkert/markdown-utils "Micro-utils for creating markdown snippets.") +- [pretty-remarkable](https://www.npmjs.com/package/pretty-remarkable): Plugin for prettifying markdown with Remarkable using custom renderer rules. | [homepage](https://github.com/jonschlinkert/pretty-remarkable "Plugin for prettifying markdown with Remarkable using custom renderer rules.") +- [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable "Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.") ### Contributing - Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Contributors - | **Commits** | **Contributor** | | --- | --- | | 196 | [jonschlinkert](https://github.com/jonschlinkert) | +| 5 | [doowb](https://github.com/doowb) | | 4 | [stefanwalther](https://github.com/stefanwalther) | +| 3 | [sapegin](https://github.com/sapegin) | | 3 | [Marsup](https://github.com/Marsup) | | 2 | [dvcrn](https://github.com/dvcrn) | | 2 | [maxogden](https://github.com/maxogden) | @@ -324,8 +347,9 @@ Pull requests and stars are always welcome. For bugs and feature requests, [plea | 1 | [sethvincent](https://github.com/sethvincent) | | 1 | [lu22do](https://github.com/lu22do) | -### Building docs +### Release history +### Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: @@ -343,17 +367,24 @@ $ npm install && npm test ``` ### Author - **Jon Schlinkert** -* [github/jonschlinkert](https://github.com/jonschlinkert) -* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ++ [github/jonschlinkert](https://github.com/jonschlinkert) ++ [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ### License - Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 19, 2017._ \ No newline at end of file +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 24, 2017._ + +[gfm-code-blocks]: https://github.com/jonschlinkert/gfm-code-blocks +[markdown-link]: https://github.com/jonschlinkert/markdown-link +[markdown-utils]: https://github.com/jonschlinkert/markdown-utils +[pretty-remarkable]: https://github.com/jonschlinkert/pretty-remarkable +[remarkable]: https://github.com/jonschlinkert/remarkable +[verb-readme-generator]: https://github.com/verbose/verb-readme-generator +[verb]: https://github.com/verbose/verb + From 398bc337aec5c19bbf810d33b3993c29ee3047af Mon Sep 17 00:00:00 2001 From: David Booth Date: Tue, 24 Oct 2017 23:49:11 -0400 Subject: [PATCH 2/4] Corrected toc marker --- .verb.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.verb.md b/.verb.md index 089cef7..ad52d14 100644 --- a/.verb.md +++ b/.verb.md @@ -1,7 +1,7 @@ ## Quick Start Assuming you want to add a TOC to README.md: 1. ```$ npm install -g markdown-toc``` -2. Edit README.md and insert the following line where you want the TOC inserted:
```<-- toc -->``` +2. Edit README.md and insert the following line where you want the TOC inserted:
`````` 3. ```$ markdown-toc -i README.md``` ## CLI diff --git a/README.md b/README.md index dd67631..85c1630 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ $ yarn add markdown-toc ## Quick Start Assuming you want to add a TOC to README.md: 1. ```$ npm install -g markdown-toc``` -2. Edit README.md and insert the following line where you want the TOC inserted:
```<-- toc -->``` +2. Edit README.md and insert the following line where you want the TOC inserted:
`````` 3. ```$ markdown-toc -i README.md``` ## CLI From d3d5aa97471eb87e4bc33bdf3dc56641dd016be3 Mon Sep 17 00:00:00 2001 From: David Booth Date: Wed, 25 Oct 2017 11:46:49 -0400 Subject: [PATCH 3/4] Single backticks inline --- .verb.md | 6 +++--- README.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.verb.md b/.verb.md index ad52d14..653bb6c 100644 --- a/.verb.md +++ b/.verb.md @@ -1,8 +1,8 @@ ## Quick Start Assuming you want to add a TOC to README.md: -1. ```$ npm install -g markdown-toc``` -2. Edit README.md and insert the following line where you want the TOC inserted:
`````` -3. ```$ markdown-toc -i README.md``` +1. `$ npm install -g markdown-toc` +2. Edit README.md and insert the following line where you want the TOC inserted:
`` +3. `$ markdown-toc -i README.md` ## CLI diff --git a/README.md b/README.md index 85c1630..827931c 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ $ yarn add markdown-toc ## Quick Start Assuming you want to add a TOC to README.md: -1. ```$ npm install -g markdown-toc``` -2. Edit README.md and insert the following line where you want the TOC inserted:
`````` -3. ```$ markdown-toc -i README.md``` +1. `$ npm install -g markdown-toc` +2. Edit README.md and insert the following line where you want the TOC inserted:
`` +3. `$ markdown-toc -i README.md` ## CLI @@ -378,7 +378,7 @@ Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 24, 2017._ +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 25, 2017._ [gfm-code-blocks]: https://github.com/jonschlinkert/gfm-code-blocks [markdown-link]: https://github.com/jonschlinkert/markdown-link From 81c44bd9628bcea17fb4a5336e876aa7318251e6 Mon Sep 17 00:00:00 2001 From: David Booth Date: Wed, 25 Oct 2017 11:53:59 -0400 Subject: [PATCH 4/4] Restored README.md from 3c6eb6a5c67707eeced3f0822e9a3a160d4b7321 --- README.md | 119 ++++++++++++++++++++---------------------------------- 1 file changed, 44 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 827931c..b8766c4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ ## Table of Contents +- [Install](#install) +- [CLI](#cli) - [Highlights](#highlights) - [Usage](#usage) - [API](#api) @@ -24,24 +26,13 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ ## Install + Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save markdown-toc ``` -Install with [yarn](https://yarnpkg.com): - -```sh -$ yarn add markdown-toc -``` - -## Quick Start -Assuming you want to add a TOC to README.md: -1. `$ npm install -g markdown-toc` -2. Edit README.md and insert the following line where you want the TOC inserted:
`` -3. `$ markdown-toc -i README.md` - ## CLI ``` @@ -50,24 +41,7 @@ Usage: markdown-toc [options] input: The Markdown file to parse for table of contents, or "-" to read from stdin. - -i: Edit the file directly, injecting the TOC at - [Highlights](#highlights) -- [Usage](#usage) -- [API](#api) - * [toc.plugin](#tocplugin) - * [toc.json](#tocjson) - * [toc.insert](#tocinsert) - * [Utility functions](#utility-functions) -- [Options](#options) - * [options.append](#optionsappend) - * [options.filter](#optionsfilter) - * [options.slugify](#optionsslugify) - * [options.bullets](#optionsbullets) - * [options.maxdepth](#optionsmaxdepth) - * [options.firsth1](#optionsfirsth1) - * [options.stripHeadingTags](#optionsstripheadingtags) -- [About](#about) - -_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_; + -i: Edit the file directly, injecting the TOC at ; (Without this flag, the default is to print the TOC to stdout.) --json: Print the TOC in JSON format @@ -91,18 +65,18 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc]( **Features** -- Can optionally be used as a [remarkable][] plugin -- Returns an object with the rendered TOC (on `content`), as well as a `json` property with the raw TOC object, so you can generate your own TOC using templates or however you want -- Works with [repeated headings](https://gist.github.com/jonschlinkert/ac5d8122bfaaa394f896) -- Uses sane defaults, so no customization is necessary, but you can if you need to. -- [filter](#filter-headings) out headings you don't want -- [Improve](#titleize) the headings you do want -- Use a custom [slugify](#optionsslugify) function to change how links are created +* Can optionally be used as a [remarkable](https://github.com/jonschlinkert/remarkable) plugin +* Returns an object with the rendered TOC (on `content`), as well as a `json` property with the raw TOC object, so you can generate your own TOC using templates or however you want +* Works with [repeated headings](https://gist.github.com/jonschlinkert/ac5d8122bfaaa394f896) +* Uses sane defaults, so no customization is necessary, but you can if you need to. +* [filter](#filter-headings) out headings you don't want +* [Improve](#titleize) the headings you do want +* Use a custom [slugify](#optionsslugify) function to change how links are created **Safe!** -- Won't mangle markdown in code examples in gfm code blocks that other TOC generators mistake as being actual headings (this happens when markdown headings are show in _examples_, meaning they arent' actually headings that should be in the toc. Also happens with yaml and coffee-script comments, or any comments that use `#`) -- Won't mangle front-matter, or mistake front-matter properties for headings like other TOC generators +* Won't mangle markdown in code examples in gfm code blocks that other TOC generators mistake as being actual headings (this happens when markdown headings are show in _examples_, meaning they arent' actually headings that should be in the toc. Also happens with yaml and coffee-script comments, or any comments that use `#`) +* Won't mangle front-matter, or mistake front-matter properties for headings like other TOC generators ## Usage @@ -117,15 +91,15 @@ toc('# One\n\n# Two').content; To allow customization of the output, an object is returned with the following properties: - - `content` **{String}**: The generated table of contents. Unless you want to customize rendering, this is all you need. - - `highest` **{Number}**: The highest level heading found. This is used to adjust indentation. - - `tokens` **{Array}**: Headings tokens that can be used for custom rendering +* `content` **{String}**: The generated table of contents. Unless you want to customize rendering, this is all you need. +* `highest` **{Number}**: The highest level heading found. This is used to adjust indentation. +* `tokens` **{Array}**: Headings tokens that can be used for custom rendering ## API ### toc.plugin -Use as a [remarkable][] plugin. +Use as a [remarkable](https://github.com/jonschlinkert/remarkable) plugin. ```js var Remarkable = require('remarkable'); @@ -154,7 +128,7 @@ Results in: ### toc.json -Object for creating a custom TOC. +Object for creating a custom TOC. ```js toc('# AAA\n## BBB\n### CCC\nfoo').json; @@ -167,7 +141,7 @@ toc('# AAA\n## BBB\n### CCC\nfoo').json; ### toc.insert -Insert a table of contents immediately after an _opening_ `` code comment, or replace an existing TOC if both an _opening_ comment and a _closing_ comment (``) are found. +Insert a table of contents immediately after an _opening_ `` code comment, or replace an existing TOC if both an _opening_ comment and a _closing_ comment (``) are found. _(This strategy works well since code comments in markdown are hidden when viewed as HTML, like when viewing a README on GitHub README for example)._ @@ -209,10 +183,11 @@ As a convenience to folks who wants to create a custom TOC, markdown-toc's inter ```js var toc = require('markdown-toc'); ``` -- `toc.bullets()`: render a bullet list from an array of tokens -- `toc.linkify()`: linking a heading `content` string -- `toc.slugify()`: slugify a heading `content` string -- `toc.strip()`: strip words or characters from a heading `content` string + +* `toc.bullets()`: render a bullet list from an array of tokens +* `toc.linkify()`: linking a heading `content` string +* `toc.slugify()`: slugify a heading `content` string +* `toc.strip()`: strip words or characters from a heading `content` string **Example** @@ -241,15 +216,15 @@ Type: `Function` Default: `undefined` -Params: +Params: - - `str` **{String}** the actual heading string - - `ele` **{Objecct}** object of heading tokens - - `arr` **{Array}** all of the headings objects +* `str` **{String}** the actual heading string +* `ele` **{Objecct}** object of heading tokens +* `arr` **{Array}** all of the headings objects **Example** -From time to time, we might get junk like this in our TOC. +From time to time, we might get junk like this in our TOC. ``` [.aaa([foo], ...) another bad heading](#-aaa--foo--------another-bad-heading) @@ -311,23 +286,25 @@ Default: `true` Strip extraneous HTML tags from heading text before slugifying. This is similar to GitHub markdown behavior. ## About + ### Related projects -- [gfm-code-blocks](https://www.npmjs.com/package/gfm-code-blocks): Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | [homepage](https://github.com/jonschlinkert/gfm-code-blocks "Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.") -- [markdown-link](https://www.npmjs.com/package/markdown-link): Micro util for generating a single markdown link. | [homepage](https://github.com/jonschlinkert/markdown-link "Micro util for generating a single markdown link.") -- [markdown-utils](https://www.npmjs.com/package/markdown-utils): Micro-utils for creating markdown snippets. | [homepage](https://github.com/jonschlinkert/markdown-utils "Micro-utils for creating markdown snippets.") -- [pretty-remarkable](https://www.npmjs.com/package/pretty-remarkable): Plugin for prettifying markdown with Remarkable using custom renderer rules. | [homepage](https://github.com/jonschlinkert/pretty-remarkable "Plugin for prettifying markdown with Remarkable using custom renderer rules.") -- [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable "Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.") + +* [gfm-code-blocks](https://www.npmjs.com/package/gfm-code-blocks): Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | [homepage](https://github.com/jonschlinkert/gfm-code-blocks "Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.") +* [markdown-link](https://www.npmjs.com/package/markdown-link): Micro util for generating a single markdown link. | [homepage](https://github.com/jonschlinkert/markdown-link "Micro util for generating a single markdown link.") +* [markdown-utils](https://www.npmjs.com/package/markdown-utils): Micro-utils for creating markdown snippets. | [homepage](https://github.com/jonschlinkert/markdown-utils "Micro-utils for creating markdown snippets.") +* [pretty-remarkable](https://www.npmjs.com/package/pretty-remarkable): Plugin for prettifying markdown with Remarkable using custom renderer rules. | [homepage](https://github.com/jonschlinkert/pretty-remarkable "Plugin for prettifying markdown with Remarkable using custom renderer rules.") +* [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable "Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.") ### Contributing + Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Contributors + | **Commits** | **Contributor** | | --- | --- | | 196 | [jonschlinkert](https://github.com/jonschlinkert) | -| 5 | [doowb](https://github.com/doowb) | | 4 | [stefanwalther](https://github.com/stefanwalther) | -| 3 | [sapegin](https://github.com/sapegin) | | 3 | [Marsup](https://github.com/Marsup) | | 2 | [dvcrn](https://github.com/dvcrn) | | 2 | [maxogden](https://github.com/maxogden) | @@ -347,9 +324,8 @@ Pull requests and stars are always welcome. For bugs and feature requests, [plea | 1 | [sethvincent](https://github.com/sethvincent) | | 1 | [lu22do](https://github.com/lu22do) | -### Release history - ### Building docs + _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: @@ -367,24 +343,17 @@ $ npm install && npm test ``` ### Author + **Jon Schlinkert** -+ [github/jonschlinkert](https://github.com/jonschlinkert) -+ [twitter/jonschlinkert](https://twitter.com/jonschlinkert) +* [github/jonschlinkert](https://github.com/jonschlinkert) +* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ### License + Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 25, 2017._ - -[gfm-code-blocks]: https://github.com/jonschlinkert/gfm-code-blocks -[markdown-link]: https://github.com/jonschlinkert/markdown-link -[markdown-utils]: https://github.com/jonschlinkert/markdown-utils -[pretty-remarkable]: https://github.com/jonschlinkert/pretty-remarkable -[remarkable]: https://github.com/jonschlinkert/remarkable -[verb-readme-generator]: https://github.com/verbose/verb-readme-generator -[verb]: https://github.com/verbose/verb - +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 19, 2017._ \ No newline at end of file