ドキュメントを作成するように docsify を触ってみた。
docsify
https://docsify.js.org/#/
この辺で、 GitHub に寄せた話をみつつ
全社ワークスペースに「GitHub」を選んだ理由と利用状況について｜ROUTE06
https://note.route06.co.jp/n/n...
ドキュメントとかまとめようかと思ってリポジトリは作ってみたけどその後特に何もやってないな、ということで環境整備を。。。
【夫婦で開発】1年かけて1週間を振り返えるアプリを本気で開発してみた
https://zenn.dev/wheatandcat/a...
を読んで docsify を知ったので試してみたというところでもある。
基本的にはここにある手順通りで進めればドキュメントができあがる。
サイドカラムの内容は自動で出た方がいいのか、編集していける方がいいのか、、、は悩ましい。
GitHub で編集するのリンクについてはこちらのプラグインを使って追加した。
njleonzhang/docsify-edit-on-github
https://github.com/njleonzhang...
普段からエディタで編集してる人には問題無いけど、ドキュメントはそうじゃない人も触ったり見たりするから、少しでも編集しやすくなれば、、、という感じで。
ドキュメントは Public じゃない場合が多そうだから、認証下におけるような、、、ということで Firebase での hosting を試してみた。
Deploy
https://docsify.js.org/#/deplo...
Firebase 自体を普段ほとんど触っていないので、そこの方が大変だった。
Firebase Hosting にホスティングしたサイトにベーシック認証をかける 🔥｜君塚史高｜note
https://note.com/kimmy/n/n7d10...
こちらを参考にさせてもらって、 functions 配下に functions/site を作ってそこで
docsify init ./site
をするような感じで。
Firebase 上のプロジェクトの権限？が足りて無くてこけたり、 GAと連携するのがデフォルトであるみたいで、そこでこけたりしつつ、、、
Firebase の console からプロジェクトつくって、GA連携はしないようにしてとりあえず deploy もできた。
Basic認証をかけるとかであれば、 Cloudflare pages あたりと連携して、 Workers で認証かけるといったこともできたのでは？と今更ながら。。。。
たまたま見つけたこちらも気になる。
Markdoc | A powerful, flexible, Markdown-based authoring framework
https://markdoc.io/