An open API service indexing awesome lists of open source software.

https://github.com/maybe515/github-markdown-memo

Markdown備忘録 - GitHub Markdown Memo -
https://github.com/maybe515/github-markdown-memo

markdown memo

Last synced: 2 months ago
JSON representation

Markdown備忘録 - GitHub Markdown Memo -

Awesome Lists containing this project

README

        

# GitHub Markdown Memo 📝
GitHubで使用できるマークダウンやフォーマットの構文を自分なりにまとめとく備忘録。
「あのマークダウンなんだっけ...」「これ表現できるのかな...」と毎度調べるのも面倒なので随時書き足していきます。



▼いつも参考にしてる記事・文献
- [基本的な書き方とフォーマットの構文 - GitHub Docs](https://docs.github.com/ja/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-text)

## 見出し - Heading -
- 1つ~6つの `#` シンボルを先頭に配置する。
```
# h1
## h2
### h3
#### h4
##### h5
###### h6
```
heading



- HTMLの `

`~`

` タグでも同様に"見出し"を生成できる。
```

h1


h2


h3


h4


h5

h6

```
heading



- `

`~`

` タグはAlign要素を指定できる。左揃え・中央揃え・右揃えさせることが可能。
```

h1


h2


h3


```
heading-align

## テキスト書式 - Text Style -
|スタイル|構文|入力例|出力|
:-:|:-:|:-:|:-:
|太字|`** **` or `__ __`|`**Maybe515**`|**Maybe515**|
|斜体|`* *` or `_ _`|`_Maybe515_`|_Maybe515_|
|取り消し線|`~~ ~~`|`~~Maybe515~~`|~~Maybe515~~|
|太字内の斜体|`** **` or `__ __` 内で
`* *` or `_ _`|`**May*be*515**`
`__May*be*515__`|**May*be*515**
__May*be*515__|
|太字かつ斜体|`*** ***`|`***Maybe515***`|***Maybe515***|
|Subscript|` `|`(Text1) Maybe515 (Text2)`|(Text1) Maybe515 (Text2)|
|Superscript|` `|`(Text1) Maybe515 (Text2)`|(Text1) Maybe515 (Text2)|



## テキスト引用 - Text Quote-
- `>` シンボルを先頭に配置する。
```
Text Quote
> Text Quote 1
>> Text Quote 2
>>> Text Quote 3
```
Text Quote
> Text Quote 1
>> Text Quote 2
>>> Text Quote 3

## コード引用 - Code Quote -
- 単一のバッククォートで文章内のコード、コマンドを引用できる。
```
GitHub `Markdown` Memo
```
GitHub `Markdown` Memo


- 3重のバッククォートで囲むと行レベルで引用ができる。
~~~
Test
```
Quote 1
Quote 2
Quote 3
```
~~~

Test
```
Quote 1
Quote 2
Quote 3
```
> [!NOTE]
> ``` (トリプルバッククォート)自体をコード化したい場合は `` タグ、もしくは ~~~ (トリプルチルダ)、```` (クアッドバッククォート)を使用するとできる。

## リンク - Link -
リンク テキストを角かっこ `[ ]` で囲み、URL をかっこ `( )` で囲む。