Skip to main content

Docusaurusでドキュメントサイトを作る

以前は mkdocs を使用してドキュメントサイト構築していましたが、 プレビューのホットリロードが遅かったり、ドキュメントのビルドがものすごく遅くて(10 分以上) さすがにしんどくなってきたので、新しい静的ドキュメント構築システムを 実験してみることにしました。

https://docusaurus.io/

導入してみるのが、この Docusaurus。 React のコンポーネントを使用して、ドキュメントを作れたり、 MDX を使用して Javasript と組み合わせて柔軟な構築ができたりすること、 見た目シンプルでわかりやすいテーマが魅力だったので 試してみることにしました。

個人的には、mkdocs になくて不満だった slug (ページごとの URL を指定できる) のができるのが導入の決め手でした。

以下、基本的なプロジェクトを作成して以降やってみたことをメモしておきます。