Create a doc
docStatic では、「トピック」と呼ばれるファイルに Markdown でコンテンツを記述します。通常は各トピックを自分で作成しますが、特定の種類のドキュメントでは自動生成されるトピックもあります。
docStatic では、「トピック」と呼ばれるファイルに Markdown でコンテンツを記述します。通常は各トピックを自分で作成しますが、特定の種類のドキュメントでは自動生成されるトピックもあります。
ページは他の種類のコンテンツとは異なり、ショーケース、プレイグラウンド、サポートページなど、単独で完結するコンテンツとして設計されています。React コンポーネントと Markdown を含めることができます。ページにはサイドバーがありません。
ドキュメント機能は、Markdown ファイルを階層形式で整理する方法を提供します。
Markdown には脚注を提供する拡張機能がありますが、その実装は一貫性がなく、コンテンツと番号が分離されてしまいます。たとえば:
docStaticは、コンテンツ作成のメインフォーマットとしてMarkdownを使用しています。10分で学ぶこともできます。ただし、CMSがメタデータ、Markdown、Reactコンポーネントのための完全なリッチテキスト編集環境を提供しているため、必ずしも習得する必要はありません。
docStaticはMDXの組み込みサポートを提供しており、MarkdownファイルにJSXを記述してReactコンポーネントとしてレンダリングできます。ただし、JSXをトピックに直接追加した場合、CMSはリッチテキストエディターでそれらを表示できません。
MDXには、MarkdownファイルをJSXに解析・変換する方法をカスタマイズするために使用できる組み込みのプラグインシステムがあります。ただし、Markdownの動作を変更する場合は、CMSにもその変更を反映する必要があります。
Related Topics コンポーネントは、共通のタクソノミータグに基づいて関連コンテンツを自動的に提案します。現在のページのタグを分析し、類似したタグを持つ他のドキュメントを検索して、推奨リストとして表示します。
Tabs コンポーネントを使用すると、トピックにタブ付きコンテンツを追加できます。