Markdown記法/書き方(見出し・表・リンク・画像・文字色など)

,

 

Markdownで簡単にドキュメントを作れるツール「NotePM」

 

Markdown(マークダウン)とは

Markdown(マークダウン)とは、「# 見出し」「* リスト」など、シンプルな書き方で文書構造を明示でき、装飾されたHTML文書に変換できる軽量マークアップ言語です。
このページでは、Markdown記法でよく使う「見出し・テーブル表・リンク・画像・文字色・強調・箇条書き」などの書き方をまとめています。

Markdownで簡単にドキュメントを作れるツール「NotePM」

Markdown記法

見出し

見出し

行頭に#を付けると見出し形式になります。
#の数が見出しレベルと一致します

入力例

# 見出し1です
## 見出し2です
### 見出し3です
#### 見出し4です

表示結果

見出し1です

見出し2です

見出し3です

見出し4です

 

太字・斜体・訂正線

太字・斜体・訂正線

  • ** または __ によって囲まれた文字列は「太字」になります。
  • * または _ によって囲まれた文字列は「斜体」になります。
  • ~~ で囲まれた文字は「訂正線」になります。

入力例

これは **太字** です。
これは __太字__ です。
これは *斜体* です。
これは _斜体_ です。
これは ~~訂正線~~です。

表示結果
これは 太字 です。
これは 太字 です。
これは 斜体 です。
これは 斜体 です。
これは 訂正線です。

Markdownで簡単にドキュメントを作れるツール「NotePM」

URLリンク

URLリンク

[表示テキスト](URL) でURLリンクになります。

入力例

[ドキュメント情報共有サービス NotePM](https://notepm.jp)

表示結果
ドキュメント情報共有サービス NotePM

 

引用

引用

行頭に > を付けると引用になります。

入力例

> これは引用です。
> これは引用です。これは引用です。

表示結果

これは引用です。
これは引用です。これは引用です。

Markdownで簡単にドキュメントを作れるツール「NotePM」

code(コード)

コード

コードブロック

「 ` ` ` 」で該当部分を囲むとコードブロックになります。

入力例

 ```
  void hello()
  {
      console.log("Hello World!");
  }
 ```

表示結果

 void hello()
 {
     console.log("Hello World!");
 }

 

インラインコード

「`」で囲まれた文字は「インラインコード」になります。

入力例

これは `code` です

表示結果
これは code です

 

テキストカラー(文字色)

markdown text colorボタン

Markdown記法では、テキストカラーの変更は対応していないため、どうしても文字色を変えたい場合は、以下のように直接HTMLタグを記述する必要があります。

入力例

これは<span style="color: red; ">赤文字</span>です

表示結果
これは 赤文字 です

入力補助機能イメージ
text-color

Markdownで簡単にドキュメントを作れるツール「NotePM」

チェックリスト

チェックリスト

行頭に - [ ] - [x] を付けるとチェックリストになります

入力例

- [ ] これからやるタスク
- [x] 完了したタスク

表示結果

  •   これからやるタスク
  •   完了したタスク

 

箇条書きリスト

箇条書きリスト

ハイフン- 、アスタリスク* または プラス+を挿入して記載します。

入力例

- リスト1
- リスト2

または

* リスト1
* リスト2

表示結果

  • リスト1
  • リスト2

Markdownで簡単にドキュメントを作れるツール「NotePM」

番号付きリスト

番号付きリスト

  • 「数字.」を入れると番号付きリストになります。
        1. という風に同じ数字でも自動的に番号付けされます。

入力例

1. 番号リストA
1. 番号リストB
  1. 番号リストB-1
  1. 番号リストB-2
1. 番号リストC

表示結果

  1. 番号リストA
  2. 番号リストB
    1. 番号リストB-1
    2. 番号リストB-2
  3. 番号リストC

 

リストの入力補助

リスト入力時にENTERキーを押すと、次のリストを自動的に生成します。
(チェックリスト形式も同様です)

リストの入力補助

 

ファイルの挿入

画像

![代替テキスト](URL) でファイルが表示されます。

入力例

![フクロウ](https://notepm.jp/build/assets/apple-touch-icon-120x120-2ee67c72.png)

表示結果

フクロウ

添付ファイルの登録方法は、「ヘルプ:添付ファイルを登録する」を参照ください。

Markdownで簡単にドキュメントを作れるツール「NotePM」

水平線(罫線)

水平線(罫線)

3つ以上の - * _ だけの行は水平線(罫線)となります。

入力例

***

*****

---

-------

_ _ _

表示結果






 

Table(テーブル)

テーブル

以下のように書くとテーブルで表示されます

入力例

|  TH  |  TH  |
| ---- | ---- |
|  TD  |  TD  |
|  TD  |  TD  |

表示結果

TH TH
TD TD
TD TD

 

テーブル入力補助については以下を参照ください。
MarkdownでTable(テーブル)を書く

Markdownで簡単にドキュメントを作れるツール「NotePM」

注釈

文中に注釈を入れることができます。

入力例

テキスト[^1]
[^1]: 注釈の内容

表示結果

イメージ

PlantUML記法

PlantUML記法でシーケンス図、コンポーネント図などのUMLを描画できます。
コードブロック記法に uml ラベルで PlantUML記法になります。

```uml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
```

PlantUML公式ページ: http://plantuml.com/ja/
PlantUMLサンプル集: https://real-world-plantuml.com/

Markdownで簡単にドキュメントを作れるツール「NotePM」

数式

コードブロックの言語指定に math を指定することで、TeX記法を用いて数式を描画できます。

参照:LaTeX記法について(ウィキペディア)

絵文字を使う

😊絵文字ボタン、または :emoji:絵文字 が書けます
絵文字を使う
NotePM