Closed dynamis closed 2 years ago
docsify から docsaurus に変更する場合は URL パスの構造が変わるので既存 URL 空のリダイレクトリストを定義したい
https://docs.netlify.com/routing/redirects/
... と思ったが https://wot-jp-cg.netlify.app/#/aboutcg → https://wot-jp-cg.netlify.app/aboutcg のようなリダイレクトを定義することは出来ない (元々 https://wot-jp-cg.netlify.app/ へのアクセスをブラウザがしてクライアントの JS で #/aboutcg から md ファイル読み込んで表示していたものなので、サーバ側のリダイレクト機能では旧 URL からのリダイレクト実装は出来ない)
力業でリダイレクト専用の JS を書いて入れることもできなくはないがイレギュラー実装を入れるほどサブページへのリンクは多くない&サイト構成は変わらないから分かるだろうと思うのでひとまずリダイレクトはナシで進める想定。
細かな部分で調整中 (画像をサイズ指定する場合の書き方を変更など、近日対応済ませて PR として貰う予定) ですが、docusaurus にするとこんな感じになるというのを見て貰える感じになりました:
https://astounding-heliotrope-d5d391.netlify.app/
フィードバック頂いて要望に対応、問題無さそうであれば PR にしてレビュー・マージで切り替えて行ければと思っています。
docusaurus 変更コードなどは一通り整理されたので #81 にてレビューやコメントを受付中です。皆様、ここまたは PR #81 にコメント・フィードバックください。
一定時間の経過と合意が出来たところで反番サイトへの反映をしたく思います。
なお、markdown の拡張仕様である MDX https://mdxjs.com/docs/ が使われるが、実際このコミュニティサイトでよく使う記法についてはサイト管理変更の how to をまとめた markdown ページを (README.md や POLICY.md などと並列で) リポジトリトップに追加しておくことで、今後の編集に迷わないようにする予定です (別途 issue or pr を立てます)。
PR #81 をマージしたため完了・クローズ
現在簡単に使える/始められる Docsify ベースでサイトを作っているが、#42 でサイドバーを折りたたみたいなどの要望もあり、色々と欲しい機能を考えると docsify ベースで続けるよりも、もっとリッチなサイトジェネレータに切り替えた上で調整するのが良さそう。
候補となる SSG リスト https://jamstack.org/generators/
私の経験としては技術系ドキュメントサイトジェネレータとしては Docusaurus v2 以降がとても良く、切り替えるとしたらそれが良いと考えています:
https://docusaurus.io/ https://docusaurus.io/showcase
v2 もまだ正式リリースではなく beta 15 (2021/5 にベータ入り) ですが、いつ正式リリースになるか分からない& v1 系列よりはかなり良いし複雑な使い方を指定ない本サイトでは v2 b15 で十分の想定。
基本 Markdown でコンテンツを書くのは共通で、若干 markdown のライブラリやスタイルの違いはあるが、ほぼそのまま既存コンテンツは移行できる想定をしている。テーマデザインは docusaurus デフォルト (docusaurus 公式と一緒) を、configuration で触れる範囲で済ませるので十分と思っています。 https://docusaurus.io/docs/api/themes/configuration
これができるのか、機能としてあるのかといった要件の確認や、他のものの方が良いなどの提案があればお知らせください。
特に要望やご意見がなければ (より重要であろう) コンテンツ執筆系が一段落したところで試験移行したサンプルデプロイを用意、確認の上で問題無ければスイッチするのが良いと考えています。