CALS Tables
Using CALS tables in docStatic, including merged cells, column widths and border control.
Using CALS tables in docStatic, including merged cells, column widths and border control.
docStatic では、「トピック」と呼ばれるファイルに Markdown でコンテンツを記述します。通常は各トピックを自分で作成しますが、特定の種類のドキュメントでは自動生成されるトピックもあります。
ページは他の種類のコンテンツとは異なり、ショーケース、プレイグラウンド、サポートページなど、単独で完結するコンテンツとして設計されています。React コンポーネントと Markdown を含めることができます。ページにはサイドバーがありません。
ダイアグラムは、コードブロック内で を使用してレンダリングできます。
ドキュメント機能は、Markdown ファイルを階層形式で整理する方法を提供します。
Markdown には脚注を提供する拡張機能がありますが、その実装は一貫性がなく、コンテンツと番号が分離されてしまいます。たとえば:
ようこそ!このガイドでは、docStaticの初回セットアップ手順を順を追って説明します。
docStaticは、ライターと開発者の間の溝を埋め、ユーザーが愛するオンラインドキュメントの作成を支援するモダンなドキュメントプラットフォームです。
docStaticでは、コンテンツ作成の主なフォーマットとしてMarkdownを採用しています。 10分で習得できます。ただし、CMSがメタデータ、Markdown、Reactコンポーネント向けの充実したリッチテキスト編集環境を提供しているため、必ずしも習得する必要はありません。
数式はを使用してレンダリングできます。
docStaticにはMDXのサポートが組み込まれており、Markdownファイル内にJSXを記述してReactコンポーネントとしてレンダリングすることができます。ただし、トピックにJSXを直接追加した場合、CMSはリッチテキストエディタ内でそれらを表示することができません。
MDXには、MarkdownファイルをJSXに解析・変換する方法をカスタマイズするために使用できる組み込みのプラグインシステムがあります。ただし、Markdownの動作を変更する場合は、CMSにもその変更を反映する必要があります。
Related Topics コンポーネントは、共通のタクソノミータグに基づいて関連コンテンツを自動的に提案します。現在のページのタグを分析し、類似したタグを持つ他のドキュメントを検索して、推奨リストとして表示します。
docStaticサイトはシングルページのReactアプリケーションです。Reactアプリのスタイリング方法と同じようにスタイルを設定できます。
Tabs コンポーネントを使用すると、トピックにタブ付きコンテンツを追加できます。
Upgrading Node.js modules.