Skip to content

yamauchi-inochu/GitBook-starter-pack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitBook-starter-pack

GitBook-starter-pack(試験版)は、node.jsの環境下で利用してください。

node.jsの公式サイトからインストーラを利用するのが早いです。 Macの場合は、Homebrew,Nodebrewを等駆使するとインストール、バージョン管理ができます。

使い方

パッケージのインストール

  1. このリポジトリ(GitBook-starter-pack)をダウンロードする。
  2. .zipファイルを解凍し、任意のディレクトリに配置する
  3. ターミナル(Mac)、コマンドプロンプト(Windows)を起動し、下記を入力する
//GitBook-starter-packに移動する
cd ./desktop/GitBook-starter-pack

//package.jsに従って、GitBookの導入に必要なものをインストールする(しばらくするとインストールが開始され、node_modulesのフォルダが作成される)。
npm i

Buildするファイルの準備

GitBook-starter-packのフォルダ内にある、book.js, README.md, SUMMARY.mdを開き確認する。

  • book.js (コンテンツのタイトルや著者を記載、プラグインを設定する)
  • README.md (ページの紹介等を記載)
  • SUMMARY.md(GitBook形式に変換する.mdのパスを記載):メニューの折りたたみには、gitbook-plugin-collapsible-menuを使用

GitBookコマンドの実行

//SUMMARY.mdのパスに従って、.mdがhtmlに変換される
npm run build

//ローカルサーバーを起動し、Gitbookの動作を確認する
npm start

参考

GitBook-starter-packは、GISオープン教材(試験公開版)© GIS-OER WG CC BY-SA 4.0を参考に作成した。

About

GitBook-starter-pack(試験版)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published