ドキュメントジェネレーター

Markdownで記述できるドキュメント

ブログもそうですが、普段ドキュメントを書く際、Markdownを使っています。

仕事ではWord,Excelがほぼ標準ですが、あまり差分を見るのには適さない(みづらい)し、履歴を追うのはできなくはありませんがお気軽感がまったくないです。

この辺うまく解消できないかなと調べてみると「Docsify」というツールが良さげな感じがしたので使ってみました。

Docsifyとは

docsify.js.org

「A magical documentation site generator.」ということで、魔法のドキュメントサイト生成です。

クイックスタート(https://docsify.js.org/#/quickstart)にしたがって構築してみました。

まずはdocsifyをインストールします。

c:\work\docs>npm i docsify-cli -g
C:\Program Files (x86)\Nodist\bin\docsify -> C:\Program Files (x86)\Nodist\bin\node_modules\docsify-cli\bin\docsify
npm WARN lifecycle The node binary used for scripts is C:\Program Files (x86)\Nodist\bin\node.exe but npm is using C:\Program Files (x86)\Nodist\v-x64\14.15.1\node.exe itself. Use the `--scripts-prepend-node-path` option to include the path for the node binary npm was executed with.

> docsify@4.11.6 postinstall C:\Program Files (x86)\Nodist\bin\node_modules\docsify-cli\node_modules\docsify
> opencollective-postinstall

Thank you for using docsify!
If you rely on this package, please consider supporting our open collective:
> https://opencollective.com/docsify/donate

npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@~2.1.2 (node_modules\docsify-cli\node_modules\chokidar\node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})

+ docsify-cli@4.4.2
added 209 packages from 92 contributors in 13.96s

続いて利用するための初期化コマンドを実行します。

c:\work\docs>docsify init ./docs

Initialization succeeded! Please run docsify serve ./docs

すると上のコマンドで指定して「docs」というフォルダ配下に以下のようにファイルが生成されます。

f:id:akky97:20201126184048p:plain

「README.MD」に少し文字を追加してみます。

# Headline

> An awesome project.

## これはテストページです

- テストドキュメントです。

初期化した際に「docsify serve ./docs」を実行してくださいと言われているので、実行してみます。

c:\work\docs>docsify serve ./docs

Serving c:\work\docs\docs now.
Listening at http://localhost:3000

Windowsfirewall設定が有効になっていると許可するかどうかの確認ダイアログが出る場合がありますが、許可をします。

これでサーバが起動したようなので「http://localhost:3000」をブラウザで見てみます。

f:id:akky97:20201126184732p:plain

ナビゲータと本文が出てきました。ちなみにレスポンシブ対応のようです。

まだ多くは試していないですが、シンプルでみやすいので使ってみようかなと思います。