gitbookify
Generates gitbook chapters and sections from a given markdown file.
Last updated 6 years ago by thlorenz .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gitbookify 
SYNC missed versions from official npm registry.

gitbookify build status

Generates gitbook chapters and sections from a given markdown file.

Installation

npm install -g gitbookify

Usage

gitbookify <file.md> --outdir <outdir> <gitbookify options>

  Generates gitbook chapters and sections from a given markdown file.

OPTIONS:

  -o, --outdir    the directory to which to write the generated files used to generate a gitbook
  -l, --loglevel  level at which to log: silly|verbose|info|warn|error|silent -- default: info
  -h, --help      Print this help message.

EXAMPLES:
  
  Generate with default options and launch gitbook server afterwards:
    
    gitbookify README.md --outdir ./my-gitbook && gitbook serve ./my-gitbook

  Override loglevel:

    gitbookify API.md --loglevel silly -o ./my-gitbook

Sections are created by separating on each # header. If headers have the same name they go into the same chapter. For more info review this example.

After generating the chapters you can use gitbook to either serve them gitbook serve ./my-gitbook or do all the other gitbook things.

Speaker Notes

Simply enclose your speaker notes in a notes comment as shown below. The notes will be printed to the browser console when you open the particular page in the gitbook.

<!-- notes
- first speaker note
  - indented sub note
-->

License

MIT

Current Tags

  • 0.2.0                                ...           latest (6 years ago)

2 Versions

  • 0.2.0                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (4)
Dev Dependencies (2)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |