https://github.com/eyworldwide/markdown2dash

Convert markdown files to Dash docset in CLI
https://github.com/eyworldwide/markdown2dash

dash-docset markdown

Last synced: 27 days ago
JSON representation

Convert markdown files to Dash docset in CLI

• Host: GitHub
• URL: https://github.com/eyworldwide/markdown2dash
• Owner: eyworldwide
• License: mit
• Created: 2017-11-14T22:45:10.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-28T06:25:10.000Z (over 6 years ago)
• Last Synced: 2024-09-14T02:08:30.707Z (about 2 months ago)
• Topics: dash-docset, markdown
• Language: JavaScript
• Size: 28.3 KB
• Stars: 15
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: License.md

Awesome Lists containing this project

README

        
# markdown2dash

[![npm version](https://badge.fury.io/js/markdown2dash.svg)](https://badge.fury.io/js/markdown2dash)

Convert markdown files to Dash docset in CLI.

## INSTALL

```bash

$ npm install -g markdown2dash

```

## USAGE

```bash

$ 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](https://kapeli.com/docsets#supportedentrytypes) 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](https://github.com/sindresorhus/github-markdown-css/blob/gh-pages/github-markdown.css) and [highlight.js](https://github.com/isagalaev/highlight.js/blob/master/src/styles/github.css).

Thanks to the authors above created beautiful styles.

# Demo

[GLSL Docset](https://github.com/eyworldwide/glsl-docset)

![screenshot](./screenshot.png)