gitbook-gen

command module
v0.0.0-...-be9fc7c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 13, 2017 License: MIT Imports: 11 Imported by: 0

README

gitbook-gen

GoDoc License Build Status Coverage Status

Generate SUMMARY.md for Gitbook.

Features

  • Recursively scan the specified directory(current for default) with depth(2 for default) to generate SUMMARY.md
  • The posts with the prefix _ are private, can be skipped when generates SUMMARY.md
  • Exclude specified directories

Install

glide update
go install

Test

./test.sh

Usage

gitbook-gen help

USAGE:
   gitbook-gen [global options] command [command options] [arguments...]

VERSION:
   1.0.0

DESCRIPTION:
   gitbook directory, current directory for default

COMMANDS:
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --depth DEPTH, -d DEPTH                 DEPTH of TOC (default: 2)
   --extensions EXTENSIONS, -e EXTENSIONS  post EXTENSIONS (separated by commas, NO spaces, include period `.`) (default: ".md,.markdown")
   --exclusions DIRECTORIES                exclude DIRECTORIES (separated by commas, NO spaces) (default: "_book")
   --show-all                              show all posts(include private)
   --help, -h                              show help
   --version, -v                           print the version

TODO

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL