Markdownとは
- Markdownは、任意のプレーンテキストエディタを使用して、ドキュメント、リッチテキスト、またはHTMLマークアップを作成できる軽量テキスト形式です。
なぜMarkdown
- 読み込み、書き込み、PDF、Word、HTMLなどのフォーマットへの変換は、簡単で、高速で、きれいで、ポータブルで、柔軟性があります。 独自のドキュメントフォーマットを心配することなく、ドキュメントの作成に専念したい作家のための標準となっています。
Markdownで何ができますか?
- 見出し、リスト、表、リンク、イメージ、引用符を作成するための一般的なマークダウン構文を書くことができます。 その後、GitHub Flavored Markdown、MultiMarkdown、R Markdown、CommonMark、Babelmarkなど、さまざまな言語の実装を調べてください。
Markdownの使い方
Headings(見出し)
- 見出しを作成するには、見出しテキストの前に1〜6つの#記号を追加します。 使用する
#
の数は、見出しのサイズを決定します。
# The largest heading
## The second largest heading
###### The smallest heading
The largest heading
The second largest heading
The smallest heading
Styling text(テキストのスタイル設定)
- 太字、イタリック、または取り消し線テキストで強調表示することができます。
Style | Syntax | Example | Output |
---|---|---|---|
Bold |
** ** or -- --
|
**This is bold text** |
This is bold text |
Italic |
* * or - -
|
*This text is italicized* |
This text is italicized |
Strikethrough | ~~ ~~ |
~~This was mistaken text~~ |
|
Bold and italic |
** ** or - -
|
**This text is _extremely_ important** |
This text is extremely important |
Quoting text(テキストの引用)
- 引用するにはこの
>
を使えます。
In the words of Abraham Lincoln:
> Pardon my French
In the words of Abraham Lincoln:
Pardon my French
Quoting code(コードの引用)
- 単一のバックティックでコード内またはコマンド内のコマンドを呼び出すことができます。 バッククォート内のテキストはフォーマットされません。
Use `git status` to list all new or modified files that haven't yet been committed.
Use git status
to list all new or modified files that haven't yet been committed.
- コードまたはテキストを独自のブロックにフォーマットするには、トリプルバックティックを使用します。
Some basic Git commands are:
```
git status
git add
git commit
```
Some basic Git commands are:
git status
git add
git commit
Lists(リスト)
- あなたは、1行または複数行のテキストの前に
-
または*
を付けて、順序なしリストを作ることができます。
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
- リストを注文するには、各行の前に番号を付けます。
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
Nested Lists(ネストされたリスト)
- ネストされたリストを作成するには、別の項目の下にある1つ以上のリスト項目をインデントします。
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
Task lists(タスクリスト)
- タスクリストを作成するには、項目を
[]
で始めるようにしてください。 タスクを完全なものとしてマークするには、[x]
を使います。
- [x] Foo
- [ ] Bar
- Foo
- Bar
Tables(テーブル)
- 2つの列と3つの行(ヘッダーを数えない場合)を持つ表の基本的な表の例は、次のとおりです。
| Column 1 | Column 2 |
|----------|----------|
| foo | bar |
| baz | qux |
| quux | quuz |
Column 1 | Column 2 |
---|---|
foo | bar |
baz | qux |
quux | quuz |
- 表の見出しをそのコロンから区切る行の中で、表の列をコロンで整列させることができます。
| Column 1 | Column 2 | Column 3 | Column 4 |
|----------|:---------|:--------:|---------:|
| default | left | center | right |
Column 1 | Column 2 | Column 3 | Column 4 |
---|---|---|---|
default | left | center | right |
Markdownフォーマットを無視する
- Markdown文字の前に
\
を使ってMarkdownフォーマットを無視(またはエスケープ)するように指示できます。
Let's rename \*our-new-project\* to \*our-old-project\*.
Let's rename *our-new-project* to *our-old-project*.