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

Markdownの機能

Docusaurusは**Markdownといくつかの追加機能**をサポートしています。

Front Matter​

Markdownドキュメントの先頭には、Front Matterと呼ばれるメタデータがあります：

my-doc.md
---
id: my-doc-id
title: ドキュメントのタイトル
description: ドキュメントの説明
slug: /my-custom-url
---

## Markdownの見出し

[リンク](./hello.md)を含むMarkdownテキスト

リンク​

URLパスまたは相対ファイルパスを使用した、通常のMarkdownリンクがサポートされています。

[ページを作成する](/create-a-page)方法を見てみましょう。
[ページを作成する](./create-a-page.md)方法を見てみましょう。

結果: ページを作成する方法を見てみましょう。

画像​

通常のMarkdown画像がサポートされています。

static ディレクトリ内の画像を参照するために絶対パスを使用できます (static/img/docusaurus.png)：

![Docusaurus logo](/img/docusaurus.png)

Docusaurus logo

現在のファイルからの相対パスで画像を参照することもできます。これは、画像を使用するMarkdownファイルの近くに画像を配置する場合に特に便利です：

![Docusaurus logo](./img/docusaurus.png)

コードブロック​

構文ハイライト付きのMarkdownコードブロックがサポートされています。

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}
```
src/components/HelloDocusaurus.js
function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}

アドモニション (警告・注釈)​

Docusaurusには、アドモニションやコールアウトを作成するための特別な構文があります：

:::tip[ヒント]

この素晴らしい機能オプションを使用してください

:::

:::danger[注意]

この操作は危険です

:::
ヒント

この素晴らしい機能オプションを使用してください

注意

この操作は危険です

MDXとReactコンポーネント​

MDXを使用すると、ドキュメントをよりインタラクティブにすることができ、Markdown内でReactコンポーネントを使用できるようになります：

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`ラベル ${children} の色 ${color} をクリックしました`)
    }}>
    {children}
  </span>
);

これは <Highlight color="#25c2a0">Docusaurus グリーン</Highlight> です！

これは <Highlight color="#1877F2">Facebook ブルー</Highlight> です！

これは Docusaurus グリーン です！

これは Facebook ブルー です！