https://github.com/1000ch/node-github-markdown

Parse GitHub flavored markdown to static html.
https://github.com/1000ch/node-github-markdown

Last synced: 3 months ago
JSON representation

Parse GitHub flavored markdown to static html.

• Host: GitHub
• URL: https://github.com/1000ch/node-github-markdown
• Owner: 1000ch
• Created: 2013-12-31T08:10:01.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2018-07-12T09:44:15.000Z (over 6 years ago)
• Last Synced: 2024-10-12T23:51:23.966Z (3 months ago)
• Language: JavaScript
• Homepage: https://npmjs.org/package/github-markdown
• Size: 129 KB
• Stars: 29
• Watchers: 5
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• project-awesome - 1000ch/node-github-markdown - Parse GitHub flavored markdown to static html. (JavaScript)

README

        
# [node-github-markdown](https://npmjs.org/package/github-markdown)

[![Build Status](https://travis-ci.org/1000ch/node-github-markdown.svg?branch=master)](https://travis-ci.org/1000ch/node-github-markdown)

[![NPM version](https://badge.fury.io/js/github-markdown.svg)](http://badge.fury.io/js/github-markdown)

[![Dependency Status](https://david-dm.org/1000ch/node-github-markdown.svg)](https://david-dm.org/1000ch/node-github-markdown)

[![devDependency Status](https://david-dm.org/1000ch/node-github-markdown/dev-status.svg)](https://david-dm.org/1000ch/node-github-markdown#info=devDependencies)

Parse GitHub flavored markdown to static html.

## Install

Install via npm.

```bash

$ npm install [--global] github-markdown

```

## Usage

Parse stdin.

```bash

$ cat readme.md | ghmd --stdin

```

Parse a markdown file.

```bash

# readme.html

$ ghmd readme.md

```

### `--dest`

Specify the destination.

```bash

# foo/readme.html

$ ghmd --dest foo readme.md

```

### `--template`

Specify custom template (defaults to standard template)

```bash

$ ghmd --template custom.jade markdown.md

```

### `--help`

Show help message.

### `--version`

Show package version.

## License

[MIT](https://1000ch.mit-license.org) © [Shogo Sensui](https://github.com/1000ch)