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

マークダウンの機能

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

##フロントの問題

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

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)

リンクについて

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

Let's see how to [Create a page](/create-a-page).
Let's see how to [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)

コードブロック

マークダウンコードブロックは構文の強調表示でサポートされています。

```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[My tip]

Use this awesome feature option

:::

:::danger[Take care]

This action is dangerous

:::
My tip

Use this awesome feature option

Take care

This action is dangerous

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 !