GitBook使用ノート

2341 ワード

1.インストール

  • 1.1インストールNodeJs
  • 1.2 Gitbookコマンドラインツールのインストール、詳細は>gitbookインストール構成公式ドキュメントnpm install gitbook-cli -g
  • 2.使用


    次の点を理解すれば、基本的には地元で楽しく本を書くことができます.

    2.1コマンドライン基本コマンド使用

  • 新規書籍、カタログで実行:gitbook init
  • 構築プレビューhtmlファイルgitbook build
  • オープンサービス閲覧中プレビューgitbook serve
  • 転送ドア:設置使用:Setup and Installation of GitBook
  • 編集後Gitライブラリにコミット:
  • git add .    
    git commit -m "    "
    

    2.2ディレクトリ構造の理解


    説明を省略して、公式の説明を直接伝えます.
    ≪トランスポート・ゲート|Transfer Gate|ldap≫:≪ディレクトリ構造|Directory Structure|ldap≫ページおよびコンテンツ・ディレクトリ

    2.3了解book.json構成方法


    転送ドア:book.json構成

    3.プラグインのインストールと構成


    プラグイン検索ブラウズ:GitBook Plugins

    3.1コードハイライト


    1)prismプラグイン
    上のリンクをクリックして構成方法を確認します(以下同)

    3.2 TOC(Table of Content)


    1)ページ内-navigator
    見出しの下に目次を表示
    2)側面-simple-page-toc
  • 右上にTOCボタンが表示する、クリックするとディレクトリ
  • が表示される.
  • 右上にTopボタンが表示され、クリックすると文章の上部
  • に戻ります.

    3.4現在の配置大集合

    {
        "title": "      ",
        "description": "      ",
        "language": "zh",
        "plugins": [
            "prism",
            "-highlight",
             "simple-page-toc",
             "navigator"
        ],
        "pluginsConfig": {
            "simple-page-toc": {
                "maxDepth": 3,
                "skipFirstH1": true
           }
        }
    }
    

    4.ドキュメントエディタの使用


    GitbookEditor


    GitBook公式出品、リンクGitbookEditorをダウンロードし、基本的なgitコマンドに慣れていない場合は、これを使用したほうがいいです.

    Sublime Text


    参考:WindowsでSublimeを使用してmarkdownを編集し、プレビューします.また、SublimeにはOpen Folder機能があります.左側にディレクトリツリーを表示できます.さらに便利なのは、ファイルディレクトリを増やしたり、ファイルディレクトリの名前を変更したりすることができます.
    ワークフロー:Sublimeでの修正-gitbook serveプレビュー-git add .およびgit commit -m "msg"コミット-git push

    5.編集(Markdown構文)


    転送:Markdown
  • コードハイライト指定コード言語-ruby指定言語をruby
  • に追加
        ```ruby
          require 'redcarpet'
          markdown = Redcarpet.new("Hello World!")
          puts markdown.to_html 
    

    リファレンス


    gitbookインストール構成公式ドキュメント