Plugin for prettifying markdown with Remarkable using custom renderer rules.
npm install pretty-remarkable> Plugin for prettifying markdown with Remarkable using custom renderer rules.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
- Install
- Usage
- Examples
- Formatting
* Tables
* Unordered lists
* Ordered lists
- About
_(TOC generated by verb using markdown-toc)_
Install with npm:
``sh`
$ npm install --save pretty-remarkable
`js`
var prettify = require('pretty-remarkable');
`js
var prettify = require('pretty-remarkable');
var Remarkable = require('remarkable');
var md = new Remarkable();
// register the plugin
md.use(prettify);
var result = md.render('\n\n\n# foo\n\n\nbar\n# baz');
//=> '# foo\n\nbar\n\n# baz'
`
Or create a function if you need to export it or need a more reusable format:
`js
var prettify = require('pretty-remarkable');
var Remarkable = require('remarkable');
function pretty(str, options) {
return new Remarkable()
.use(prettify)
.render(str);
}
pretty('\n\n\n# foo\n\n\nbar\n# baz');
//=> '# foo\n\nbar\n\n# baz'
`
In addition to the formatting mentioned in the following sections:
* does not modify code or gfm code blocksoptions.condense
* ensures that an extra newline precedes gfm code blocks, since some text editors do not display proper hightlighting otherwise
* unless is false, condenses 3+ newlines down to two
Normalizes table formatting.
Example
`markdown`
Before
A|B|C
|---:|:---|---|
a |b |c
x |y |z
After
Is normalized to:
`markdown
Before
| A | B | C |
| ---: | :--- | --- |
| a | b | c |
| x | y | z |
After
`
Normalizes unordered lists.
Example
`markdown`
* a
* b
* c
* d
* e
* f
Is normalized to:
`markdown`
* a
* b
- c
- d
+ e
+ f
Normalizes ordered lists.
Example
`markdown
1. foo
a. aaa
b. bbb
c. ccc
1. bar
1. baz
`
Is normalized to:
`markdown
1. foo
a. aaa
b. bbb
c. ccc
2. bar
3. baz
`
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
`sh`
$ npm install && npm test
Building docs
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
* markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage with Remarkable.")
* markdown-utils: Tiny helpers for creating consistenly-formatted markdown snippets. | homepage
* prettify-markdown: Prettify, format or beautify your markdown. Whatever you want to call it, this does that… more | homepage
* remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage
Jon Schlinkert
* LinkedIn Profile
* GitHub Profile
* Twitter Profile
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on July 05, 2018._