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

Markdownの機能

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

フロントマター​

Markdownドキュメントの上部には、フロントマターと呼ばれるメタデータがあります：

my-doc.md
---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---

## Markdown heading

Markdown text with [links](./hello.md)

リンク​

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

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

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

画像​

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

絶対パスを使用して、静的ディレクトリ（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>;
}

警告（Admonitions）​

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(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
);

This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !

This is <Highlight color="#1877F2">Facebook blue</Highlight> !

This is Docusaurus green !

This is Facebook blue !