https://github.com/1000ch/node-github-markdown
Parse GitHub flavored markdown to static html.
https://github.com/1000ch/node-github-markdown
Last synced: about 2 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 (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-07-12T09:44:15.000Z (almost 7 years ago)
- Last Synced: 2025-03-01T06:42:35.660Z (2 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
README
# [node-github-markdown](https://npmjs.org/package/github-markdown)
[](https://travis-ci.org/1000ch/node-github-markdown)
[](http://badge.fury.io/js/github-markdown)
[](https://david-dm.org/1000ch/node-github-markdown)
[](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)