Zennやgithubなどで使う基本的なmarkdown記法まとめ

2024/08/26に公開

今まで調べ調べやって目を背けてきましたが、勉強のためZennを書くにあたってまとめていきたいと思います。

参考
ZennのMarkdown記法一覧

見出し

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
**太字**

見出し1

見出し2

見出し3

見出し4

太字
常識的には見出し2から使用するのが好ましいとされています。

リスト

- リスト
  - インデントにも対応しています
1. 番号付きリスト
  2. これもインデントに対応
  • リスト
    • インデントにも対応しています
  1. 番号付きリスト
  2. これもインデントに対応

引用

> 引用

引用

インラインスタイル-コード

文中に`code`を挿入

文中にcodeを挿入

インラインスタイル-打消し線

~~打消し線~~

打消し線

インラインスタイル-イタリック

*イタリック*

イタリック

テーブル

| Head | Head | Head |
| ---- | ---- | ---- |
| Text | Text | Text |
| Text | Text | Text |
Head Head Head
Text Text Text
Text Text Text

コードブロック

```

```


``` で囲います

言語とファイル名を指定

```js:ファイル名

```

ファイル名
this.code = parfect

シンタックスハイライト

マージ前後を比較するのとかにおすすめです

```diff js
- this.code = tooBad

+ this.code = nice
 ```

-  this.code = tooBad
+  this.code = nice

コードブロック同様ファイル名を書くこともできる
方法もコードブロック同様

add-name
-  this.code = noName
+  this.code = addName

区切り線

-----

埋め込みテキストリンク

[ZennのMarkdown記法一覧](https://zenn.dev/zenn/articles/markdown-guide)

ZennのMarkdown記法一覧

脚注

参考[^1]
[^1]: https://zenn.dev/zenn/articles/markdown-guide

参考[1]

インラインのコメント

メモを残しておきたい時にはhtml方式のコメントアウトを用いることでコメントを残せる

<!-- memo: 追記するべきトピックス -->

脚注
  1. https://zenn.dev/zenn/articles/markdown-guide ↩︎

Discussion