Docsify で あつまれ ドキュメント の森 [ 設置編 ]

ほかにもいろいろありますが、unwriterというエンジニアがよく愛用していたため
私は他の誰かに激推しでもされない限り Docsify を利用しています。

今回は改めて設置する運びになったので、その流れを書き記します。特別難しくないです。

Docsifyの公式はこちらです。

今回は 特定のディレクトリ配下に設置 しました。「/doc/api」を参照した時にDocsifyになります。

今回は上記のディレクトリに移動して、妥当なアカウントで以下のコマンドを叩きます。npm類はすでにいれています。

cd /***/***/***/doc/api
npm i docsify-cli -g

この場所を Docsify にとってルートにするので、

docsify init ./

と、します。

するとこうちょろっとファイルが吐き出されます。

これでdocsifyを起動すると

docsify serve ./

でた。「localhost:3000」。これでは意味がないので串をさします。ついでにポートを調整するには

docsify serve ./ --port 3333

です。pm2で管理するのでapp.jsonで整えます。

app.json

{
	"name" : "分かりやすい名前",
	"script" : "docsify serve ./ --port *****"
}

pm2 start app.json

で起動しときます。
つづいて、Apacheで串を設定して

...
  #Docsify
  <Location "/doc/api">
    ProxyPass http://127.0.0.1:*****/
    ProxyPassReverse http://127.0.0.1:*****/
  </Location>

  <Directory "document root path">
    #以降の記述はここに記述
  </Directory>
</VirtualHost>

で、 httpd を restart して閲覧してみます。

OKですね。