小举人 マニュアル

↑↓ で選択 Enter で開く Esc で閉じる

Docusaurus 試行錯誤の記録

Docusaurusとは何か、何ができるのか、そして私がそれをドキュメントサイトとしてどのように使い込んでいるか。

約2分で読めます
このページの内容

#Docusaurus(ドキュメント・ドラゴン)とは何か 🦖?

Docusaurusは、Facebookが主導してオープンソース化した、Reactフレームワークをベースにした静的サイトジェネレーターです。モダンなデザインでレスポンシブ対応の静的サイトを、手軽に構築できます。公式のスローガンを借りれば、「コンテンツを中心に据えたサイトを素早く構築する」ためのものです。

Docusaurusは、Document(ドキュメント)とDinosaurs(恐竜)から成る合成語です。そのため、直訳すると「文書の龍」、つまり「ドキュメント・ドラゴン」となります(こういう合成語は本当に発音しにくいのですが)。これはアメリカ人らしい言葉遊びで、有名なお笑い集団の名前をもじるような、ちょっとしたパロディの感覚に近いものです。

#Docusaurusで何ができるのか?

  • バージョン管理、検索、シンタックスハイライトなど、ドキュメントシステムの機能を提供します。
  • ブログ機能に対応しているので、ブログをすばやく立ち上げられます。
  • テーマシステム:テーマのスタイルをカスタマイズできます。事例紹介はこちらでご覧になれます。
  • プラグインシステム:プラグインで機能を拡張できます。
  • 検索エンジンのクロールに配慮した、SEOへの最適化サポート。
  • すぐに使える、シンプルな設定。
  • 活発なコミュニティ。Facebookがオープンソース化しています。
  • 多言語対応。グローバルなサイト構築が可能です。

info もしあなたのプロダクトが世界中のユーザー向けのヘルプドキュメントセンターを構築しているなら、ドキュメント・ドラゴンこそが唯一の選択肢でしょう。

#Docusaurusのインストール方法は?

TODO