メインコンテンツまでスキップ

Markdownの機能

docStaticでは、コンテンツ作成の主なフォーマットとしてMarkdownを採用しています。 10分で習得できます。ただし、CMSがメタデータ、Markdown、Reactコンポーネント向けの充実したリッチテキスト編集環境を提供しているため、必ずしも習得する必要はありません。

シンプルな構造化編集​

docStatic のトピックは、以下の 3 つの部分で構成されています。

  • メタデータ（YAML 形式）
  • コンテンツ（Markdown）
  • あらかじめ定義された React コンポーネント

CMSは、メタデータとMarkdownが一貫して使用されるように管理し、Reactコンポーネントは統一されたスタイルとコンテンツの再利用機能を提供します。コンポーネントはすでにグローバルに利用可能であるため、自分でJSXコードを追加する必要はありません。

標準機能​

Markdownの機能には以下が含まれます：

  • 太字、コード、斜体、取り消し線の書式。
  • 箇条書きおよび番号付きリスト。
  • コードブロック。
  • 見出しレベル（1～6）。
  • 水平線。
  • 画像。
  • リンク。
  • 引用。
  • 簡易表。

これらはすべて、CMSのリッチテキストツールバーから直接選択できます。

これらに加え、Docusaurusでは以下の機能が追加されています：

  • 注意書き
  • 詳細（展開可能なコンテンツ）
  • ドキュメントカード一覧
  • タブ

docStatic では、さらに以下の機能が拡張されています：

フロントマター​

フロントマターは、Markdown ファイルにメタデータを追加するために使用されます。ファイルの最上部に、3つのダッシュ（---）で囲んで記述します。コンテンツプラグインによっては、独自のフロントマタースキーマが用意されている場合があります。docStatic では、フロントマターを以下の目的で使用します：

  • 条件（条件付きテキスト用）
  • 説明
  • スラグ （固定パス）
  • タクソノミータグ
  • タイトル
  • ワークフローステータス

詳細​

  1. Embed リストから Details を選択します。
  2. コンポーネントを編集します。
  3. Summary を入力します。
  4. Details を入力します。

例：​

切り替える。

これは詳細なコンテンツです。

ここでは、太字や斜体のテキスト、インラインリンクなど、Markdownを使用できます。

ドキュメントカードリスト​

ドキュメントカードリストは、目次のカテゴリに対して自動的に生成されます。ただし、トピックに手動で追加することも可能です。

  1. Embed リストから Doc Card List を選択します。
  2. タイトルを指定します。

詳細については、Docusaurus ドキュメントの Markdown 機能 を参照してください。

例:​

📄️Context-sensitive help

「コンテキストセンシティブヘルプとは、ソフトウェアの特定の状態から取得するの一種で、その状態に関連する状況のヘルプを提供するものです。コンテキストセンシティブヘルプは、一般的なオンラインヘルプやオンラインマニュアルとは異なり、全体を通して読めるようにする必要はありません。各トピックは、ソフトウェアの1つの状態、状況、または機能を詳細に説明することを目的としています。」—

📄️Snippets

Snippet コンポーネントを使用すると、ドキュメント全体でコンテンツを再利用できます。スニペットは、1つ以上のトピックに挿入できるコンテンツのかたまりです。スニペットを変更すると、スニペットが使用されているすべての箇所に変更が反映されます。これは定型文に特に便利です。スニペットはCMSに専用のコレクションがあり、リポジトリの専用セクションに格納されています。