SGDoc

SGDoc

Markdown document generator.

Install

sudo npm install sgdoc -g

Source

You can check source code at github.

Usages

Original Template

sgdoc [input markdown] [output file]

With Your own Template

sgdoc [input markdown] [output file] [template]

Markdown

You can use markdown code like Github.

Syntax Higlight

Syntax higlight for sgdoc is same like github.

Example :

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

Will show like

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

Syntax Theme

sgdoc is using highlight.js. You can check syntax highligh theme from demo page.

Template

Template is just html file and you must add {{toc}} and {{docCode}}

Sample Template

You can downlod original template for reference.

MISC

Inspirations

Flatdoc have inspired SGDoc. Original template design are base on Flatdoc's theme-white CSS.

Changelog

Version 0.6.6

Acknowledgements

SGDoc is authored and maintained by Saturngod. Released under the MIT License.