Readme Export Parser
A tiny library for parsing markdown files exported from
ReadMe. Provides a single function as the default
export, parse
, and a set of JSDoc type definitions for
the various content block types.
Usage
The only export is a function that takes a ReadMe markdown string as its only argument, and returns a document data object. The following:
const fs = const parseReadmeMarkdown = const srcMD = fsconst data = console
Would output something along the lines of:
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request