Guides

Learn about the most important docStatic concepts.

📄️Creating pages

ページは他の種類のコンテンツとは異なり、ショーケース、プレイグラウンド、サポートページなど、単独で完結するコンテンツとして設計されています。React コンポーネントと Markdown を含めることができます。ページにはサイドバーがありません。

📄️Wikis

ウィキページは、コラボレーションのために設計されたウェブ/ドキュメントページです。数分で作成・編集でき、チーム内部のナレッジ共有や公開向けヘルプコンテンツによく使用されます。

📄️Styling and layout

docStaticサイトはシングルページのReactアプリケーションです。Reactアプリのスタイリング方法と同じようにスタイルを設定できます。

📄️Static assets

スタティックアセットとは、ビルド出力に直接コピーされるコード以外のファイルです。画像、スタイルシート、ファビコン、フォントなどが含まれます。

📄️Search

デフォルトでは、docStaticは検索を使用するよう設定されています。主な利点はコストゼロのソリューションであることです。主な欠点は、検索インデックス全体がユーザーのブラウザにダウンロードされるため、サイトが大きくなるほど遅くなることです。

docStatic を使用すると、ドキュメントに関する質問に答える AI チャットボットをサイトに追加できます。デフォルトでは、WebLLM（WebGPU 経由）を使用して訪問者のブラウザ上で完全に実行されるため、外部サービス、API キー、サーバーは一切必要ありません。また、このウィジェットは、訪問者に表示される内容を一切変更することなく、ご自身でホストしている有料プロバイダーを指定して利用することも可能です。

📄️Browser support

docStatic では、browserslist 設定を使用してサポートするブラウザのリストを定義できます。通常、ウェブサイトは最新のブラウザで問題なく動作します。

📄️Search engine optimisation (SEO)

docStaticは以下のさまざまな方法で検索エンジン最適化をサポートしています。

📄️Using plugins

静的サイトジェネレーターのコアは独自の機能を提供しません。すべての機能は個々のプラグインに委ねられています。ドキュメント機能は、ブログ機能は、個別ページはによって提供されています。

📄️Deployment

デフォルトでは、docStatic はにデプロイされます。その他のオプションについては、Docusaurus ドキュメントのを参照してください。

📄️Internationalization

国際化（）のサポートは静的サイトジェネレーターによって提供されています。詳細については、Docusaurusドキュメントのを参照してください。

📄️CLI

docStatic には、ウェブサイトの生成、配信、デプロイを支援する一連のスクリプトが用意されています。これらは、サイトの package.json 内の scripts セクションで定義されており、これが正式な一覧となります。引数を指定せずに npm run を実行すると、サイトに実際に含まれているスクリプトが表示されます。