LabHub

ブログ

Markdownガイド

한국어English日本語

はじめに

Markdownおよび Mdxの解析は、unified やその他のremarkおよびrehypeパッケージを通じてサポートされています。next-mdx-remote を使用すると、webpackを変更することなく、.mdx および .md ファイルをより柔軟に解析できます。

GitHub Flavored Markdownが使用されています。mdx-prism はコードブロックにシンタックスハイライト機能を提供します。以下は全体の見た目のデモです。

以下のMarkdownチートシートは https://guides.github.com/features/mastering-markdown/ から引用しています。

Markdownとは?

Markdownは、Web上でテキストをスタイリングする方法です。ドキュメントの表示をコントロールでき、太字やイタリックへの書式設定、画像の追加、リストの作成など、Markdownでできることはたくさんあります。基本的に、Markdownは #* のようないくつかの非アルファベット文字が含まれた通常のテキストです。

構文ガイド

GitHub.comやお使いのテキストファイルで使用できるMarkdown構文の概要です。

見出し

# これはh1タグです

## これはh2タグです

#### これはh4タグです

これはh1タグです

これはh2タグです

これはh4タグです

強調

_このテキストはイタリックになります_

**このテキストは太字になります**

_これらを**組み合わせる**ことができます_

このテキストはイタリックになります

このテキストは太字になります

これらを組み合わせることができます

リスト

順序なしリスト

- Item 1
- Item 2
  - Item 2a
  - Item 2b

順序付きリスト

1. Item 1
1. Item 2
1. Item 3
   1. Item 3a
   1. Item 3b
  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

画像

![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Format: ![Alt Text](url)

GitHub Logo

リンク

http://github.com - automatic!
[GitHub](http://github.com)

http://github.com - automatic! GitHub

引用

As Kanye West said:

> We're living the future so
> the present is our past.

Kanye Westはこう言いました:

We're living the future so the present is our past.

インラインコード

I think you should use an
`<addr>` element here instead.

代わりに <addr> 要素を使用すべきだと思います。

シンタックスハイライト

GitHub Flavored Markdownでシンタックスハイライトを使用する方法の例です:


js:fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}

そしてこのように表示されます - きれいに色付けされ、スタイル付きのコードタイトルが付いています!

fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}

脚注

Here is a simple footnote[^1]. With some additional text after it.

[^1]: My reference.

これは簡単な脚注です1。その後にいくつかの追加テキストがあります。

タスクリスト

- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

テーブル

単語のリストをハイフン - で区切り(最初の行)、各列をパイプ | で分離することでテーブルを作成できます:

| First Header                | Second Header                |
| --------------------------- | ---------------------------- |
| Content from cell 1         | Content from cell 2          |
| Content in the first column | Content in the second column |
最初のヘッダー2番目のヘッダー
セル1のコンテンツセル2のコンテンツ
最初の列のコンテンツ2番目の列のコンテンツ

取り消し線

2つのチルダで囲まれた単語(~~this~~ のように)は 取り消し線 で表示されます。

Footnotes

  1. 参考文献。

コメント

まだコメントはありません。

ログインするとコメントできます