目的
- docsifyを使って、ドキュメントをサイト生成する。
結果
docsifyとは
- ドキュメントをウェブサイト生成する。
- GitBookのように、静的なHTMLファイルを生成するのではなく、マークダウンを読み込み、パースし、ウェブサイト上に表示する。
特長
- HTMLをビルドしない
- シンプルで軽い
- テキスト検索できる
- 複数のテーマを指定できる
- 絵文字をサポートしている
など.....
導入方法
npm i docsify-cli -g
初期設定
./docsに諸々配置したい場合、
docsify init ./docs
これを実行すると、./docs配下に以下のファイルが生成されます。
index.html- エントリーファイル。
README.md- 最初に表示される画面
nojekyll- Github Pagesが、アンダースコアから始まるファイルを無視しないようにするために必要。 が生成されます。
起動方法
カレントディレクトリを先ほど設定したdocsと同じ階層に移動し、以下コマンドを実行すると、http://localhost:3000にサーバーを起動します。
docsify serve docs
バージョンについて
- バージョンのアップデートは、手動で変える必要があります。
index.htmlにdocsifyのscriptやcssを読み込んでいますが、@4のような書き方の場合、マイナーアップデートやバグ修正を自動的に取り込んでいるので、推奨されているようです。- バージョンを固定したい場合は、URLの@シンボルの数字を指定することで固定できます。
参考
- docsify docsify.js.org
