esa.io の Markdown 記法のうち、よく使うものを紹介します
> 見出し見出し
#
を行頭に付けることで、見出しになります。 #
の数と見出しの階層が対応します。
# これは h1 タグです
## これは h2 タグです
### これは h3 タグです
#### これは h4 タグです
↓
> これは h1 タグですこれは h1 タグです
> これは h2 タグですこれは h2 タグです
> これは h3 タグですこれは h3 タグです
これは h4 タグです
> 箇条書き箇条書き
箇条書きリストは、 -
*
のどれかを入力し、半角スペースまたはタブを挿入します。
半角スペースまたはタブを行頭に挿入すると、箇条書きが入れ子になります。
- リスト 1
- リスト 2
- リスト 2a
- リスト 2a1
- リスト 2b
↓
- リスト 1
- リスト 2
- リスト 2a
- リスト 2a1
- リスト 2b
- リスト 2a
> 番号付きリスト番号付きリスト
番号付きリストは、 <数字>.
を入力し、半角スペースまたはタブを挿入します。どの数字を入力しても、番号付けは自動で行われます。
半角スペースまたはタブを行頭に挿入すると、リストが入れ子になります。
1. foo
1. bar
1. baz
1. aaa
2. bbb
3. ccc
↓
- foo
- bar
- baz
- aaa
- bbb
- ccc
> リンクリンク
[表示テキスト](URL)
でリンクになります
[esa.io (\\( ⁰⊖⁰)/) ](https://esa.io)
> 画像画像

で画像が貼れます

↓
> 引用引用
行頭に >
を挿入すると引用(blockquote)として表示できます。
esa.io にはこのように書いてあります。
> esa.io は「情報を育てる」という視点で作られた、
> 小さな開発チームのためのドキュメント共有サービスです。
↓
esa.io にはこのように書いてあります。
esa.io は「情報を育てる」という視点で作られた、
小さな開発チームのためのドキュメント共有サービスです。
> 強調(太字)強調(太字)
2つの *
または、_
で文言を囲むと、強調(太字・strong)が表現できます。
それは私の**エサ**です。
↓
それは私のエサです。
> 訂正線訂正線
2つの ~
で文言を囲むと、訂正線(del
)が表現できます。
それは~~いぬ~~トリのエサです。
↓
それはいぬトリのエサです。
> 罫線罫線
3つ以上の *
-
と半角スペースのみの行は、罫線 (hr
) として表現できます。
本文終わり。
---
Enjoy! (\\( ⁰⊖⁰)/) from esa.io
↓
本文終わり。
Enjoy! (\( ⁰⊖⁰)/)
> コードコード
> インライン表示インライン表示
インラインのコードは、`<code>` タグです。
↓
インラインのコードは、<code>
タグです。
> コードブロック表示コードブロック表示
``` $ git push origin master ```
↓
$ git push origin master
> シンタックスハイライトシンタックスハイライト
```ruby def esa puts "(\\( ⁰⊖⁰)/)" end ```
↓
def esa
puts "(\\( ⁰⊖⁰)/)"
end
※現在 esaでは rougeというライブラリを使用しております。対応言語一覧はこちらです。
> ファイル名表示ファイル名表示
```ruby:Gemfile gem 'rails' gem 'esa' ``` ```ruby:tori.rb puts '(\( ⁰⊖⁰)/)' ```
gem 'rails'
gem 'esa'
puts '(\( ⁰⊖⁰)/)'
> 数式数式
> mathコードブロックmathコードブロック
```math
e^{i \pi} = -1
```
> inlineMathinlineMath
$a = \\{1, 2, 3\\}$
$a = \{1, 2, 3\}$
> UML (PlantUML)UML (PlantUML)
```uml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
```
> テーブルテーブル
| アイテム名 | 値段 |
| ------------ | ------------- |
| いぬのえさ | 250円 |
| とりのえさ | 128円 |
※ テーブル記法の前の行は空行である必要があります。
↓
アイテム名 | 値段 |
---|---|
いぬのえさ | 250円 |
とりのえさ | 128円 |
参考: release_note/2015/01/24/テーブル記法を書きやすくしました - docs.esa.io
> タスクリストタスクリスト
- [ ] TODO
- [ ] TODO
- [x] DONE
↓
-
TODO
- TODO
- DONE
> 絵文字絵文字
:emoji:
で、絵文字が表示できます。詳しくはEmoji cheat sheet 参照下さい
絵文字は投稿タイトルや見出しでも利用できます。
> メンションメンション
@USERNAME
でユーザーに対してメンションが送れます。メンションが送られると画面右上の通知欄から通知されます。
@
を入力すると、チーム内のメンバーがサジェストされます。
> チーム内投稿へのリンクチーム内投稿へのリンク
#
から入力すると、チーム内の投稿がサジェストされ、楽にリンクが投稿できます。
> エスケープエスケープ
\
でMakdownで使われる記号がエスケープできます。
\# ほげ
\- hoge
\\hoge
(\\( ⁰⊖⁰)/)
↓
# ほげ
- hoge
\hoge
(\( ⁰⊖⁰)/)
> 脚注記法脚注記法
脚注を付けたい場所にこのように書きます→ [^1]
[^1]: ここに脚注の内容を書きます