## Usage ```js var prettify = require('{%= name %}'); ``` ## Examples ```js var prettify = require('{%= name %}'); 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('{%= name %}'); 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** ```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 ``` ### Unordered lists Normalizes unordered lists. **Example** ```markdown * a * b * c * d * e * f ``` Is normalized to: ```markdown * a * b - c - d + e + f ``` ### Ordered lists 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 ```