gitbookのメモがあれば、他の人に質問されても答えが見つからない心配はありません!!

詳細ドキュメント

1.1 gitbook紹介

1.2 gitbook

をインストールする

1.3 gitbookプロジェクト

を作成

1.4 gitbookスタイル

を設定する

2.1ディレクトリ階層

を設定する.

2.2使用例

2.3 test-book/summary.mdにディレクトリ構造

を加える

3.1 gitbookのいくつかの一般的なプラグイン

3.2折り畳みモジュール(ページコンテンツ折り畳み可能)

3.3ページ内ディレクトリ(book.jsonのpluginsパラメータにプラグイン名を追加)

を生成

3.4 gitbookコードハイライト

4.1 gitbookを

にパッケージ

4.2 gitbook 3.x.xバージョンバグによりbuild後のファイルがページ

に自動的にジャンプできない
1.1 gitbookの紹介
GitBookが使用するmarkdown文法に基づいて、いくつかの作文の利便性を強化しました.
Markdownは軽量級の「タグ言語」で、利点は:

レイアウトスタイルではなく文字の内容に集中します.

簡単なエクスポートHTML、PDF、およびそれ自体の.mdファイル

純テキスト内容、すべてのテキストエディタとワード処理ソフトウェア

を互換性

読み取り可能、直感的.すべての人に適した作文言語

1.2 gitbookのインストール

npm install gitbook-cli -g   #   gitbook
gitbook  help                #   gitbook    
gitbook  -V                  #   gitbook    

1.3 gitbookプロジェクトの作成

C:\Users\tom>  cd C:\aa\test-book            #             
C:\aa\test-book>  gitbook init               #       
C:\aa\test-book>  gitbook serve --port 80    #    80    gitbook    
#    ：http://localhost:80

1.4 gitbookスタイルの設定

book.json

{
    "language": "zh-hans",
    "plugins": [
        "livereload",
        "highlight",
        "search",
        "lunr",
        "-sharing",
        "fontsettings",
        "theme-default"
    ],


    "styles": {
        "website": "styles/website.css"
    }

}

styles/website.css

.gitbook-link {
    display: none!important;
}

2.1ディレクトリ階層の設定
ここでは直接_book同級ディレクトリの下にbook.jsonファイルを作成し、3.3生成ディレクトリファイルの構成を貼り付けます.

説明

1. test-book      SUMMARY.md     gitbook init                  markdown             

2. SUMMARY.md     markdown             ，             【  * [  ](README.md) 】

　　1）  ：              ，         ，         

　　2）   ：       

　　3）   ：             

　　4）    README.md                                           

2.2使用例

対応するファイルディレクトリ構造

を作成する.

cd /c/aa/test-book                         #  windows   git  test-book   ，   linux  
mkdir -p chapter{1,2,3}                    #  test-book      ：chapter1  chapter2  chapter3
touch chapter{1,2,3}/chapter{1,2,3}.md     #              ：chapter1.md  chapter2.md  chapter3.md
touch chapter{1,2,3}/section{1,2,3}.md     #              ：section1.md  section2.md  section3.md

2.3 test-book/summary.mdにディレクトリ構造を追加する

# Summary

* [  ](README.md)
* [   ](chapter1/chapter1.md)
    * [ 1 ](chapter1/section1.md)
    * [ 2 ](chapter1/section2.md)
    * [ 3 ](chapter1/section3.md)
* [   ](chapter2/chapter2.md)
    * [ 1 ](chapter2/section1.md)
    * [ 2 ](chapter2/section2.md)
    * [ 3 ](chapter2/section3.md)
* [   ](chapter3/chapter3.md)
    * [ 1 ](chapter3/section1.md)
    * [ 2 ](chapter3/section2.md)
    * [ 3 ](chapter3/section3.md)
* [  ](summary.md)

3.1 gitbookの一般的なプラグイン
参考ブログ:https://segmentfault.com/a/1190000019806829?utm_source=tag-newest

{
    "plugins": [
        "splitter",              # splitter         
        "copy-code-button",      #       
        "highlight",             #     
        "accordion",             #     (       )
        "back-to-top-button",    #       
        
        "search-pro",            # search-pro      ，        ，      search lunr     
        "-search",         
        "-lunr",
        
        "chapter-fold",                   #        
        "expandable-chapters",            #            ，        chapter-fold   bug
        "-expandable-chapters-small",     #        ，       chapter-fold    bug

        "fontsettings",
        "livereload",            #  GitBook      
        "popup",                 #           
        
        "-sharing",              #         
        "theme-default",
        "theme-comscore",        #     ，         
        "page-treeview"          #          

    ],

    "styles": {
        "website": "styles/website.css"
    }
}

test-book/book.json:プラグイン

を追加

{
    "plugins": [
        "-search",
        "-sharing",
        "theme-default",
        "-lunr",
        "fontsettings",
        "livereload",
        "popup",
        "splitter",
        "copy-code-button",
        "highlight",
        "-expandable-chapters-small",
        "chapter-fold",
        "back-to-top-button",
        "search-pro",
        "-expandable-chapters"
    ],

    "styles": {
        "website": "styles/website.css"
    }

}

gitbook install#に追加されたプラグインはありません.インストールする必要があります(このプラグインは多く、インストールに時間がかかります)

gitbook serve--port 80#再実行プロジェクト

3.2折りたたみモジュール(ページ内容は折りたたみ可能)

#  book.json plugins        
{
    "plugins": ["accordion"]
}

3.3ページ内ディレクトリの生成(book.jsonのpluginsパラメータにプラグイン名を追加)

page-treeview

{
    "plugins": ["page-treeview"],
    "pluginsConfig": {
        "page-treeview": {
            "copyright": "Copyright © aleen42",
            "minHeaderCount": "2",
            "minHeaderDeep": "2"
        }
    }
}

3.4 gitbookコードハイライト

prism

{
    "plugins": [
        "prism",
        "prism-themes"
    ],
    "pluginsConfig": {
        "prism": {
            "css": ["prism-themes/themes/prism-duotone-dark.css"]
        }
    }
}

4.1 gitbookを梱包する

C:\Users\tom>  cd C:\aa\test-book     #   gitbook    
C:\aa\test-book>  gitbook build       #       html  

4.2 gitbook 3.x.xバージョンバグによりbuild後のファイルが自動的にページをジャンプできない

#     ：_book\gitbook\theme.js
#          ，     ，           ： if(m)for(n.handler&&
#  if(m)  if(false)