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

Markdown features

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

シンプルな構造化オーサリング​

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

  • メタデータ（YAML形式）
  • コンテンツ（Markdown形式）
  • 事前定義されたReactコンポーネント

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

標準機能​

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

  • 太字、コード、斜体、取り消し線の文字スタイル
  • 箇条書きリストと番号付きリスト
  • コードブロック
  • 見出しレベル（1〜6）
  • 水平線
  • 画像
  • リンク
  • 引用
  • シンプルなテーブル

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

これらに加えて、Docusaurusは以下を追加しています。

docStaticはさらに以下で拡張しています。

フロントマター​

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

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

詳細（Details）​

  1. 埋め込み リストから Details を選択します。
  2. コンポーネントを編集します。
  3. 概要（Summary） を設定します。
  4. 詳細内容 を入力します。

例:​

クリックして展開

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

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

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

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

  1. 埋め込み リストから Doc Card List を選択します。
  2. タイトル を設定します。

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

例:​

📄️Context-sensitive help

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

📄️Snippets

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