UNPKG

github-markdown

Version:

Parse GitHub flavored markdown to html.

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

1000ch/node-github-markdown

61 lines (38 loc) • 1.27 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# [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)