Markdown
Markdown とは
Markdown は、文書の書き方です。
非常に簡単な文法なので、Markdown を知らない人でもだいたいの意味が理解できます。 最近では、多くのドキュメントが HTML ではなく、Markdown で書かれるようになってきています。
例えば、箇条書きは次のように入力するだけです。非常に簡単ですね。
- アイテム 1
- アイテム 2
- アイテム 3
はじめての Markdown
Markdown で文章を書いてみましょう。
index.md
というファイルを作成して VSCode で開いてください。その中に次のコードを書いてみてください。Ctrl
と K
を同時に押してから、V
を押すと、右側にプレビューが表示されます。もしくは、このサイトの Markdown をリアルタイムで編集してプレビューができるプレイグラウンドにコードを書いてみてください。
**Hello** World!
Markdown の記法
ここでは、Markdown の記法をいくつか紹介します。
#
と書くことで見出しを書くことができます。ライブエディターLoading...結果http://localhost:3000##
は#
の一個下の見出しです。ライブエディターLoading...結果http://localhost:3000**
で強調することができます。ライブエディターLoading...結果http://localhost:3000>
とすることで引用することができます。ライブエディターLoading...結果http://localhost:3000箇条書きは次のようにして書けます。
ライブエディターLoading...結果http://localhost:3000番号付き箇条書きは次のようにして書けます。
ライブエディターLoading...結果http://localhost:3000バッククォート(
`
)で囲むことでインラインコードを表示することができます。ライブエディターLoading...結果http://localhost:3000バッククォート 3 つで、コードブロックを表示することができます。
ライブエディターLoading...結果http://localhost:3000リンクは次のようにして表すことができます。
ライブエディターLoading...結果http://localhost:3000画像は次のようにして表示することができます。もちろんローカル上のファイルも扱えます。
ライブエディターLoading...結果http://localhost:3000実は、Markdown の中には HTML も書くことができます。
ライブエディターLoading...結果http://localhost:3000多くの場合、LaTeX の記法で数式を書くこともできます。
ライブエディターLoading...結果http://localhost:3000
Markdown を拡張した MDX というものもあります。実は、Docusaurus で使うことができるのは Markdown ではなく MDX です。MDX は、Markdown の中で JSX 記法 を使えるものです。JSX 記法 は、JavaScript の中に HTML を書くことができるものですが、詳しいことは自分で調べてみてください。ここでは、簡単に例を紹介します。
JavaScript を文書の中に書くことができるので、例えば次のような表現が可能です。
ちなみに、このシケプリではライフゲームのコンポーネントを作ったので、それを使うときはファイルの先頭で次のようにインポートしてから、次のように書くだけでライフゲームを表示できます(笑)
import LifeGame from "@site/src/components/LifeGame";