Awesome
pretty-remarkable
![Linux Build Status](https://img.shields.io/travis/jonschlinkert/pretty-remarkable.svg?style=flat&label=Travis)
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.
(TOC generated by verb using markdown-toc)
Install
Install with npm:
$ npm install --save pretty-remarkable
Usage
var prettify = require('pretty-remarkable');
Examples
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:
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'
Formatting
In addition to the formatting mentioned in the following sections:
- does not modify
code
or gfm code blocks - ensures that an extra newline precedes gfm code blocks, since some text editors do not display proper hightlighting otherwise
- unless
options.condense
is false, condenses 3+ newlines down to two
Tables
Normalizes table formatting.
Example
Before
**A**|**B**|**C**
|---:|:---|---|
a |b |c
x |y |z
After
Is normalized to:
Before
| **A** | **B** | **C** |
| ---: | :--- | --- |
| a | b | c |
| x | y | z |
After
Unordered lists
Normalizes unordered lists.
Example
* a
* b
* c
* d
* e
* f
Is normalized to:
* a
* b
- c
- d
+ e
+ f
Ordered lists
Normalizes ordered lists.
Example
1. foo
a. aaa
b. bbb
c. ccc
1. bar
1. baz
Is normalized to:
1. foo
a. aaa
b. bbb
c. ccc
2. bar
3. baz
About
<details> <summary><strong>Contributing</strong></summary>Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
</details> <details> <summary><strong>Running Tests</strong></summary>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:
$ npm install && npm test
</details>
<details>
<summary><strong>Building docs</strong></summary>
(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:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
</details>
Related projects
You might also be interested in these projects:
- markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage
- 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
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 05, 2018.