Guides
Learn about the most important docStatic concepts.
Creating pages
ページは他の種類のコンテンツとは異なり、ショーケース、プレイグラウンド、サポートページなど、単独で完結するコンテンツとして設計されています。React コンポーネントと Markdown を含めることができます。ページにはサイドバーがありません。
ドキュメント
2項目
Blog
ブログ機能を使用すると、タイムスタンプ付きの記事を作成できます。
Wikis
ウィキページは、コラボレーションのために設計されたウェブ/ドキュメントページです。数分で作成・編集でき、チーム内部のナレッジ共有や公開向けヘルプコンテンツによく使用されます。
Markdownの機能
20項目
Styling and layout
docStaticサイトはシングルページのReactアプリケーションです。Reactアプリのスタイリング方法と同じようにスタイルを設定できます。
Static assets
スタティックアセットとは、ビルド出力に直接コピーされるコード以外のファイルです。画像、スタイルシート、ファビコン、フォントなどが含まれます。
Search
デフォルトでは、docStaticはLunr検索を使用するよう設定されています。主な利点はコストゼロのソリューションであることです。主な欠点は、検索インデックス全体がユーザーのブラウザにダウンロードされるため、サイトが大きくなるほど遅くなることです。
Browser support
docStatic では、browserslist 設定を使用してサポートするブラウザのリストを定義できます。通常、ウェブサイトは最新のブラウザで問題なく動作します。
Search engine optimisation (SEO)
docStaticは以下のさまざまな方法で検索エンジン最適化をサポートしています。
Using plugins
静的サイトジェネレーターのコアは独自の機能を提供しません。すべての機能は個々のプラグインに委ねられています。ドキュメント機能はdocsプラグイン、ブログ機能はblogプラグイン、個別ページはpagesプラグインによって提供されています。
Deployment
デフォルトでは、docStatic は GitHub Pages にデプロイされます。その他のオプションについては、Docusaurus ドキュメントの Deployment を参照してください。
Internationalization
国際化(i18n)のサポートは静的サイトジェネレーターによって提供されています。詳細については、Docusaurusドキュメントのi18n - Introductionを参照してください。
CLI
docStatic は、ウェブサイトの生成、提供、デプロイを支援する一連のスクリプトを提供しています。