マークダウン記法の書き方

  • 見出し/ヘッダー
    • H1:# H1 見出し
    • H2:## H2 見出し
    • H3:### H3 見出し
    • H4:#### H4 見出し
    • H5:##### H5 見出し
    • H6:###### H6 見出し
  • 箇条書き/リスト
    • 順序なし:* 項目 もしくは - 項目
    • 番号付き:1. 項目2. 項目、…
  • 区切り/水平線/ヘアライン:--- もしくは ***
  • リンク
    • URL のみのリンク:<https://example.com>
    • テキストリンク:[Example](https://example.com)
  • イタリック体/斜体:*斜体* もしくは _斜体_
  • 太字/強調:**太字** もしくは __斜体__
  • 太字の斜体:***太字*** もしくは ___斜体___
  • 打ち消し線:~~訂正~~
  • 画像の埋め込み:![画像](img/picture.jpg)

参考:

Markdown 記法一覧 – Qiita

Markdown 記法 サンプル集 – Qiita

README.md ファイル。マークダウン記法まとめ | codechord

Markdown 記法 チートシート – GitHub Gist

.md ファイルの書き方 | ncxx-sl-lab/members Wiki – GitHub

Markdown 記法まとめ (見出し、段落、改行、水平線、強調、引用、コード) | はしくれエンジニアもどきのメモ

Markdown 記法まとめ (リスト、リンク、画像、インライン HTML、エスケープ) | はしくれエンジニアもどきのメモ

Basic Syntax | Markdown Guide

Cheat Sheet | Markdown Guide

Mastering Markdown – GitHub Guides

Markdown Syntax Documentation – Daring Fireball

GitHub

参考:

Basic writing and formatting syntax – User Documentation | GitHub [Official]

github/linguist: Language Savant. If your repository’s language is being reported incorrectly, send us a pull request! – GitHub

linguist/vendor at master · github/linguist – GitHub

linguist/languages.yml at master · github/linguist – GitHub

Qiita

参考:

Qiita マークダウン記法 一覧表・チートシート – Qiita

Qiita でシンタックスハイライト可能な言語一覧 – Qiita

エディタ

参考:

おすすめエディタ | はしくれエンジニアもどきのメモ

VSCode で編集する

参考:

VS Code で Markdown をプレビューするには? | @IT

コードブロック/シンタックスハイライト

バッククォート3つで囲む。最初のバッククォート3つの後にシンタックスハイライトする言語を指定する。

```Ruby
print "Hello"
```

参考:

Markdown のシンタックスハイライトに対応している言語一覧 (GitHub) | ねこの足跡R

コードブロックでシンタックスハイライト可能な言語一覧 (GitHub) | DevelopersIO

コードブロックの作成と強調表示 | GitHub Docs [公式]

Qiita でシンタックスハイライト可能な言語一覧 – Qiita

List of supported languages and lexers · rouge-ruby/rouge Wiki – GitHub

github/linguist/lib/linguist/languages.yml – GitHub

ページ内リンクを張る

参考:

Github Markdown Heading Anchors – GitHub Gist

ローカルの画像を埋め込む

参考:

Markdown で画像を相対パスで指定する | 一歩ずつ学ぶ (step-learn.com)

How to display local image in markdown – Stack Overflow

動画を埋め込む

代替手段

  • アニメーション GIF として埋め込む
  • リンクを張る

参考:

Markdown に Youtube の動画リンクを画像付きで埋め込む – GitHub Gist

Markdown で記事に Vimeo, TED 動画を埋め込む – Qiita

Markdown 記法で動画を埋め込みたい – teratail

Insert video in README.md for an extension of vscode – Stack Overflow

CommonMark

参考:

CommonMark [Official]

CommonMark Spec [Official]

CommonMark の仕様とか – Qiita

CommonMark の現状 2017年4月版 | Islands in the byte stream

GitHub Flavored Markdown

参考:

GitHub Flavored Markdown Spec [Official]

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です