pm

prettify-markdown

Prettify, format or beautify your markdown. Whatever you want to call it, this does that. Used on hundreds of projects by verb.

Showing:

Popularity

Downloads/wk

18

GitHub Stars

9

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

1

Size (min+gzip)

0.7KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

prettify-markdown NPM version

Prettify, format or beautify your markdown. Whatever you want to call it, this does that. Used on hundreds of projects by verb.

Install with npm

npm i prettify-markdown --save

Currently this does very basic, naive formatting focusing on headings and whitespace control.

This was just externalized from verb, where this case was used on hundreds of projects to format API documentation. As basic as it is, this has gotten the job done pretty consistently.

Usage

var prettify = require('prettify-markdown');

// pass a string of markdown
var result = prettify(str);
  • markdown-toc: Generate a markdown TOC (table of contents) with Remarkable.
  • remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more

Running tests

Install dev dependencies:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

Copyright (c) 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on April 26, 2015.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100