マークダウン入門
「太字強調」の書き方:
2重のアスタリスクかアンダーバーで文字列を囲みます。
ボールド体のフォントになります。
例:
**強調したい文字列**
__強調したい文字列__
※
*hoge* はemタグ,
**hoge** はstrongタグに相当

マークダウン入門
「太字強調」の書き方:
2重のアスタリスクかアンダーバーで文字列を囲みます。
ボールド体のフォントになります。
例:
**強調したい文字列**
__強調したい文字列__
※
*hoge* はemタグ,
**hoge** はstrongタグに相当
マークダウン入門
「イタリック(斜体)」の書き方:
アスタリスクかアンダーバーで文字列を囲みます。
英数字などは斜体になります。
日本語文字列をイタリック指定しても,見た目の変化が起こらないことがあります。
例:
*hoge*
_fuga_
マークダウン入門
「読み取り専用のチェックボックス」の書き方:
箇条書き記法と組み合わせて,
readonlyなcheckboxを表示できます。
[ ] チェック無し
[x] チェック済み
例:
- [x] 要件定義
- [x] 基本設計
- [ ] 詳細設計
- [ ] コーディング
マークダウン入門
「箇条書き」の書き方:
番号や順序のあるリストを書くには,
「1. 」を使います。
数字の1の部分は,適切な番号に自動的に置換されます。
例:
1. hoge
1. fuga
1. fuga
1. boo
マークダウン入門
「箇条書き」の書き方:
番号や順序のないリストを書くには,
ハイフンかアスタリスクの後ろに
半角スペースを1つ挿入します。
リストをネストするには,半角スペース4つでインデントします。
例:
- hoge
- fuga
- fuga
- boo
マークダウン入門
「水平線(hrタグ)」の書き方:
「* _ -」のどれかを3つ以上書きます。
連続して書く際,間にスペースがあっても構いません。
例:
---
***
_______
※3つ以上ならいくつでもよい。
プレーンテキストの区切りとしてもわかりやすいですね。
マークダウン入門
「罫線付き見出し」とは:
文字列の次の行に
=(イコール)か
-(ハイフン)の行があると,
その文字列が見出しになる。
=と-の数はいくつでもいい。
=ならh1
-ならh2の見出しになる。
マークダウン入門
「見出し」の書き方:
シャープの後ろに半角スペースを1つ入れる
例:
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
マークダウン入門
「段落のinterrupt」とは
https://qiita.com/tk0miya/item...
・通常 CommonMark では,空行を段落の終わりとみなす。
・「段落のinterrupt」は,
あるマークアップが「空行を含めずに段落に割り込み,別の要素を書き始める」ことを許容する文法。
マークダウン入門
「強制改行」の書き方:
・行末に半角スペースを2つ
・brタグでも可能
「(通常の)改行は,最終的な出力結果から取り除かれる。
これは、画面の大きさに応じて改行を行う処理は
Webブラウザが担当すべきである
という設計思想による。」
マークダウン入門
README.md が持つ重要な役割
https://deeeet.com/writing/201...
リポジトリ訪問者が自ツールを使ってくれるか否かの第一歩が,README.mdにかかっている。
(1) 使い方やインストール方法の説明
(2) プロジェクトの宣伝
マークダウン入門
Markdown形式で書かれた
拡張子が「.md」のファイル
その中で最も有名なもの
https://code-ship-blog.wemotio...
・GitHubの README.md:
プロジェクトの説明,ツールの使い方,インストール方法などを理解してもらうために記述
マークダウン入門
WordやExcelなどと比べた場合の
マークダウン記法のファイルの利点とは
https://neos21.hatenablog.com/...
・バイナリ形式のファイルより,プレーンテキストのほうがバージョン管理しやすい
・CSSで見栄えを調整できる
・素のままでも読みやすい
マークダウン入門
Qiitaの記事本文をMarkdown形式で表示するには?
https://help.qiita.com/ja/arti...
・記事URLの末尾に .md を付けると,マークダウン形式で表示される。
・各記事の先頭の三点リーダから「Markdownで本文を見る」を選んでもよい。
マークダウン入門
Markdown記法を使って数式を書く方法
https://qiita.com/MuAuan/items...
コードブロックの言語名をmathにすれば,
TeX記法で数式を記述できる。
例:対数積分の式
```math
\int \frac{x}{\log x} dx
```
マークダウン入門
Markdown記法を使ってUMLを描くには
https://www.eureka-moments-blo...
・プラットフォームによるが,たとえばVisual Studio Codeなどでは,マークダウン内で「PlantUML記法」を利用できる。
・PlantUMLチートシート
https://qiita.com/ogomr/items/...
.
マークダウン入門
「Boost Note」とは:
https://qiita.com/kodai_0122/i...
・Markdown記法を使ったメモアプリで,
コードやコマンドを記録しておける。
・2019年12月まで「Boostnote」という名前で,
200カ国以上の60万人が使う人気アプリだった。
マークダウン入門
Qiita Markdown
https://qiita.com/tk0miya/item...
・CommonMark では,各ブロックレベル要素ごとに「段落にinterrupt」できるかどうかが定義されている。
・Qiita Markdown は,段落の interruptに対応していない。新要素の開始時は改行が必要。
マークダウン入門
CommonMarkとは何か
https://qiita.com/Prof-Cheese/...
・Markdown登場時,記法の解釈に幅があったため
処理系によって動作が異なる「バベルの塔」状態が生まれた。
・解釈の揺れをなくし,統一された仕様を決めるために作られたのが「CommonMark」