ドキュメントサイトジェネレータdocsifyを一瞬で立てるだけ
PocoPotaドキュメントサイトジェネレータdocsifyを一瞬で立てるだけします
docsifyは一般的な性的サイトジェネレータと違って、buildなどしてmdファイルからhtmlファイルを生成するようなことはしません。mdファイルをいい感じに解釈して、いい感じにwebサイトとして公開してくれるようです。
今回docsifyの詳しいことについては書かないので、さっさと構築します。
PocoPota公式ドキュメントを参考にさっさと構築します。
公式ドキュメントがdocsifyで作られているようで、良いサンプルになりそうです。
多分有志によって日本語訳されてるのもありました↓thx
PocoPota基本公式ドキュメント通りですが以下に色々書きます...
インストール
npm i docsify-cli -g
初期設定的な
docsify init
docsify initをすると諸々のファイルが生成されます。生成されたREADME.mdファイルがトップページのファイルなのでこいつを編集します。
docsify serve
でローカルでサーバーが立ち上がります。
PocoPotaサイドバーを設定します。
生成されているindex.htmlのscript部分に以下を追加します。
window.$docsify = {
+ loadSidebar: true,
name: '',
repo: ''
}
次に_sidebar.mdファイルを作成します。そこにサイドバーの情報を記します。
例えば以下がサンプル
- Introduction
- [Introduction](/)
- ガイド
- [ガイド](ja/guide.md)
サイドバーに目次の一部も追加したいので以下のようにします。
どのくらいの深さの目次まで表示するかを決めることができます。
window.$docsify = {
loadSidebar: true,
+ subMaxLevel: 3,
name: '',
repo: ''
}
今回はものすごく簡単なドキュメントサイトを作るのが目的なので、カスタマイズはこれで終わりにしておきます。最低限。
記事を追加したい場合は新たにmdファイルを作成するだけです。まだディレクトリを作ると、その通りにサイトに反映されます。
PocoPota次にGithub Pagesで公開してみようと思います。まぁこっちもめちゃ簡単なんですが。
まずは適当なリポジトリを作り、作成したファイル郡をコミットなりなんなりします。
そしたらpagesで公開設定をします。
以上です。
docsifyはmdファイルのまま、いい感じに表示してくれるのでこれで終わりというわけですね。
PocoPota：：：：：：：：：補足：：：：：：：：：
./docsサブディレクトリにドキュメントを書く場合は以下を実行すると、そのディレクトリに諸々のファイルが生成されます。
docsify init ./docs
またこのとき、サーバーを立ち上げるコマンドは以下です
docsify serve docs