docsify-cli をやめて vite でドキュメントの動作確認を行う

[fsubal]

経緯

• docsify で basePath を設定するとローカルでの動作確認がほぼできなくなる
  • http://localhost:5000 で立ち上がり、相対パスで指定された画像や md ファイルが全部 404 になる
  • feat(serve): --base-path serves docs from a subpath to match GitHub pages docsifyjs/docsify-cli#47 はずっと放置されている
• 本番では pixiv.github.io/charcoal/docs という URL でドキュメントが配信されている
  • ローカルで同じ状況での動作確認がしたければ http://localhost:5000/docs のような立ち上げ方ができるツールが良い

いまの docsify-cli ではこれが叶わないので別のツールで開発サーバーを立ち上げるように変える

やったこと

いくつか候補をさがしてみて（ http-party/http-server vercel/serve など ）、いずれも basePath に相当する機能をサポートしてないことが分かった。

と思ったが実は vite にこの機能があった（かつ vite はすでにインストールされている）のでそれでやってみる。

https://ja.vitejs.dev/guide/build.html#public-base-path

js や css の依存解決が一切必要ないところに vite を使うのは若干不思議な感じだが、もっとも簡単かつこの分野で信頼できるツールの一つだと思うのでまぁ良いでしょう。

バージョニング

{+ 破壊的変更なし +} / {- 破壊的変更あり -}

• 破壊的変更がある場合には、対象のパッケージのメジャーバージョンが上がっていることを確認した

チェックリスト

不要なチェック項目は消して構いません

• 追加したコンポーネントが index.ts から再 export されている

[pnlybubbles]

よさそうです!