sgd

sgdoc

Generate HTML documentation from Markdown

Showing:

Popularity

Downloads/wk

0

GitHub Stars

0

Maintenance

Last Commit

8yrs ago

Contributors

0

Package

Dependencies

3

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

#SGDoc

Markdown documentation 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

  • First Publish release.

##Acknowledgements

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial