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

Markdown

Markdown とは

Markdown は、文書の書き方です。

非常に簡単な文法なので、Markdown を知らない人でもだいたいの意味が理解できます。 最近では、多くのドキュメントが HTML ではなく、Markdown で書かれるようになってきています。

例えば、箇条書きは次のように入力するだけです。非常に簡単ですね。

- アイテム 1
- アイテム 2
- アイテム 3

はじめての Markdown

Markdown で文章を書いてみましょう。

index.md というファイルを作成して VSCode で開いてください。その中に次のコードを書いてみてください。CtrlK を同時に押してから、V を押すと、右側にプレビューが表示されます。もしくは、このサイトの Markdown をリアルタイムで編集してプレビューができるプレイグラウンドにコードを書いてみてください。

**Hello** World!

Markdown の記法

ここでは、Markdown の記法をいくつか紹介します。

  1. # と書くことで見出しを書くことができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  2. ### の一個下の見出しです。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  3. ** で強調することができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  4. > とすることで引用することができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  5. 箇条書きは次のようにして書けます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  6. 番号付き箇条書きは次のようにして書けます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  7. バッククォート( ` )で囲むことでインラインコードを表示することができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  8. バッククォート 3 つで、コードブロックを表示することができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  9. リンクは次のようにして表すことができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  10. 画像は次のようにして表示することができます。もちろんローカル上のファイルも扱えます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  11. 実は、Markdown の中には HTML も書くことができます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
  12. 多くの場合、LaTeX の記法で数式を書くこともできます。

    ライブエディター
    Loading...
    結果
    http://localhost:3000
備考

Markdown を拡張した MDX というものもあります。実は、Docusaurus で使うことができるのは Markdown ではなく MDX です。MDX は、Markdown の中で JSX 記法 を使えるものです。JSX 記法 は、JavaScript の中に HTML を書くことができるものですが、詳しいことは自分で調べてみてください。ここでは、簡単に例を紹介します。

JavaScript を文書の中に書くことができるので、例えば次のような表現が可能です。

ライブエディター
結果
Loading...

ちなみに、このシケプリではライフゲームのコンポーネントを作ったので、それを使うときはファイルの先頭で次のようにインポートしてから、次のように書くだけでライフゲームを表示できます(笑)

import LifeGame from "@site/src/components/LifeGame";
ライブエディター
結果
Loading...