GitBookのスターターキット。
以下のスライドでこの構成がどのように使われているかを解説しています。
実際にこの構成を利用しているプロジェクトとして以下のものがあります。
GitBookを使った書籍を以下のようにするだけで書き始めることができます。
git clone https://github.com/azu/gitbook-starter-kit.git your-book-name
cd your-book-name
npm install
# 必要に応じて不要な.git履歴を削除
rm -rf .git/
git init
npm start
GitBookのローカルサーバが立ち上がり、 http://localhost:4000/ にアクセスすることでプレビューできます。
npm run build
単純にビルドだけをしたい場合は、npm run buildで行うことができます。
(_book/にHTMLファイルが生成されます。)
gitbook-starter-kitでは以下のようなディレクトリ構造になっています。
.
├── README.md
├── SUMMARY.md <= 目次
├── ja/ <= .mdの文章を追加する
├── prh.yml
├── src/ <= サンプルコード
└── test/ <= サンプルコードのテスト
文章を追加するja/というディレクトリ名には独別な意味はないため好きな名前に変更して問題ありません。
文章を追加する場合は以下の手順で行うことができます。
ja/以下にMarkdownファイルで文章を追加するSUMMARY.mdに追加したMarkdownファイルへのリンクを書く
追加した後はnpm startなどでGitBookでプレビューすれば表示を確認することができます。
(デフォルトで自動的にリロードされるようになっています。)
npm test
npm testで以下のテストが実行されます。
並列でテストを実行できるようにnpm-run-allを利用しています。
テスト結果の表示が混ざるのが気になる場合は、--parallelオプションを外してみてください。
textlintを使った文章のチェックが行われます。 デフォルトでは技術書向けの設定が導入されているため目的にあわせてtextlintのルールを設定してください。
- textlintで日本語の文章をチェックする | Web Scratch
- Collection of textlint rule · textlint/textlint Wiki
- textlint-ja/textlint-rule-preset-ja-technical-writing: 技術文書向けのtextlintルールプリセット
prh.ymlに辞書を追加することで表記揺れをチェックすることができます。 詳しい設定方法については以下を参照してください。
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
MIT