Qranoko Docs:運用の楽なCMSへ移行させる
Openfirst published: 2018/12/18last updated: 2019/01/15
Qranoko DocsというVuePressで作りはじめたドキュメントサイト(基本は個人運用)があるのだけど、更新のためにエディタを開くのが億劫になってきた。v1アップデートも色々変更点があるので面倒。
最近はheadlessCMSをいじることが増え、Markdownファイルの編集より楽なのを感じている。VuePressはナビも手動修正なのが辛い...。
バックエンドをheadlessCMSにするのは難しいだろうなー。そういう用途で設計されてないもの。となると、VuePressっぽい装いで裏を自由にできる何かを探した方がいいか。この際、表示速度は二の次にして運用しやすいものを。
あらためて、技術選定。
Docusaurus
最初に思いついたのはDocusaurus。GraphQLのFacebookが作っているのでheadlessCMSと連携できる仕組みあるかもと思ったけど、無かった。
ReactのVuePress。作られたのはDocusaurusが先だろうけど。やることもほぼ一緒で、ナビやMarkdownの更新が面倒。シンプルではある。
Gatsby
やっぱり真面目に作ろうかなと考え、Gatsbyを参照。ドキュメントサイト用の手頃なスターターは無かったけど、Reactサイトがそういう構成のはず。
ナビゲーションを自動生成しているかと思ったど、YAMLでIDとタイトルが列挙されていた。OSSはGitHubで作業しているからか、他のドキュメントサイトもほとんどこのパターンだった。良い例が見つからない。
Notion
Notionで編集して公開するのは最高に楽。ただ、独自ドメインが使えなくてランダムなハッシュになるのでサイトとは言い難い。一時的な共有向き。
2019年にAPIでデータを引っ張れるようになるらしいので、それまで下書きしといて一気に作るのもありかと考えたけど、新しいAPIを学んで階層化されているデータを表示するのは大変そう。可能になってもすぐにはやらないかな。
GitBook
前に少し触っていたGitBookを思い出してアクセスしてみたら、v2リリースで根本的に変わっていた。React製のWYSIWYGで、Notion・Dropbox Paper・Mediumを彷彿させる操作感。UIはとても良くなっていた。
ホスティングメインに舵を切ったらしく、無料でカスタムドメインも使える。有料は最低でも5アカウント分(月4000円くらい?)だけど、OSSは無料らしい。
用途に合ってそうなので移行テスト。
Before
After
階層化・構造の変更を柔軟にできるので楽になった。見出しのパーマリンクを右に移せたのも良い。1階層目にはグルーピング機能もある。バージョンごとの書き分けもできるらしいけど今回は使わないかな。あと、検索が早い。
カスタムCSSなどはない。特別な表紙ページみたいなのも作れないので、GitBookのみで見栄えのいいサイトを作るとかはできそうにない。
また、インポート機能が無いため、今まで書いた文は地道にコピペしていくことになる。ついでに内容を整理。エクスポートはJSON+アセット出力。
思いのほか使い心地が良かったので、移し終えたらリダイレクトさせようと思う。他のOSSのドキュメントも移せそう。CSSフレームワークとかも、iframeでデモを貼れば成り立つかもしれない。