Gitbook writing technical documents

Time:2020-8-1

Gitbook is a static site writing tool based on GIT and GitHub. They have an official website with many good books
See https://www.gitbook.io/

Here are some records of gitbook’s writing

Interface editing

Download editorhttps://github.com/GitbookIO/editor

command line

The following only records the main command line using process, the article editing function is not written
http://segmentfault.com/ It’s too much trouble pasting pictures

install

npm -g install gitbook
npm -g install gitbook-plugin
npm install gitbook-plugin-disqus
npm install gitbook-plugin-ga

Command parameters

timgerdeMac-mini:PythonToScala_Zh timger$ gitbook 

  Usage: gitbook [options] [command]

  Commands:

    build [options] [source_dir] Build a gitbook from a directory
    serve [options] [source_dir] Build then serve a gitbook from a directory
    pdf [options] [source_dir] Build a gitbook as a PDF
    epub [options] [source_dir] Build a gitbook as a ePub book
    mobi [options] [source_dir] Build a gitbook as a Mobi book
    init [source_dir]      Create files and folders based on contents of SUMMARY.md
    publish [source_dir]   Publish content to the associated gitbook.io book
    git:remote [source_dir] [book_id] Adds a git remote to a book repository

  Options:

    -h, --help     output usage information
    -V, --version  output the version number


config

timgerdeMac-mini:PythonToScala_Zh timger$ cat book.json
{
    "plugins": ["ga", "disqus"]
    "pluginsConfig": {
        "ga": {
            "token": "UA-29124639-6"
        },
    "disqus": {
            "shortName": "yishenggudou"
        }
    }
}

build

gitbook build  ./ -o ./build --config=book.json

release

cp -vrf ../PythonToScala_Zh/build/* ./
git add -f ./*
. ~/.bashrc
. ~/.bash_profile
git_commit_msg "pub"
push_auto_branch 

Online address

http://www.timger.info/PythonToScala/index.html

Package pdf

timgerdeMac-mini:PythonToScala_Zh timger$ gitbook pdf  ./ -o ./python2scala.pdf --config=book.json
Starting build ...
Successfully built!