markdown2dash

Convert markdown files to Dash docset in CLI

MIT License

Downloads
19
Stars
15

markdown2dash

Convert markdown files to Dash docset in CLI.

INSTALL

$ npm install -g markdown2dash

USAGE

$ md2dash -i {markdownDirectory} -o {docsetDirectory}
  • markdownDirectory: default value is ./markdown
  • docsetDirectory: default value is ./docset

Just type md2dash without args If you've put .md files in markdown directory.

The subdirectories of markdownDirectory must name after Types and the directory structure should be organized like this:

- {markdownDirectory}
	- Functions
		- {xxx}.md
		- {xxx}.md
	- Statements
		- {xxx}.md
		- {xxx}.md
	- Types
		- {xxx}.md
		- {xxx}.md

Flavor

Use github flavor, include github-markdown-css and highlight.js.

Thanks to the authors above created beautiful styles.

Demo

GLSL Docset

Package Rankings
Top 13.37% on Npmjs.org
Badges
Extracted from project README
npm version
Related Projects