esa.io の Markdown 記法のうち、よく使うものを紹介します
#
を行頭に付けることで、見出しになります。 #
の数と見出しの階層が対応します。
# これは h1 タグです
## これは h2 タグです
### これは h3 タグです
#### これは h4 タグです
# これは h1 タグです
## これは h2 タグです
### これは h3 タグです
#### これは h4 タグです
↓
箇条書きリストは、 -
*
のどれかを入力し、半角スペースまたはタブを挿入します。
半角スペースまたはタブを行頭に挿入すると、箇条書きが入れ子になります。
- リスト 1
- リスト 2
- リスト 2a
- リスト 2a1
- リスト 2b
- リスト 1
- リスト 2
- リスト 2a
- リスト 2a1
- リスト 2b
↓
番号付きリストは、 <数字>.
を入力し、半角スペースまたはタブを挿入します。どの数字を入力しても、番号付けは自動で行われます。
半角スペースまたはタブを行頭に挿入すると、リストが入れ子になります。
1. foo
1. bar
1. baz
1. aaa
2. bbb
3. ccc
1. foo
1. bar
1. baz
1. aaa
2. bbb
3. ccc
↓
[表示テキスト](URL)
でリンクになります
[esa.io (\\( ⁰⊖⁰)/) ](https://esa.io)
[esa.io (\\( ⁰⊖⁰)/) ](https://esa.io)
![代替テキスト](画像URL)
で画像が貼れます
![patapata (\\( ⁰⊖⁰)/)](https://img.esa.io/uploads/production/pictures/105/3203/image/378bedb1186931ecfa019e92dafc1692.gif)
![patapata (\\( ⁰⊖⁰)/)](https://img.esa.io/uploads/production/pictures/105/3203/image/378bedb1186931ecfa019e92dafc1692.gif)
↓
行頭に >
を挿入すると引用(blockquote)として表示できます。
esa.io にはこのように書いてあります。
> esa.io は「情報を育てる」という視点で作られた、
> 小さな開発チームのためのドキュメント共有サービスです。
esa.io にはこのように書いてあります。
> esa.io は「情報を育てる」という視点で作られた、
> 小さな開発チームのためのドキュメント共有サービスです。
↓
esa.io にはこのように書いてあります。
esa.io は「情報を育てる」という視点で作られた、
小さな開発チームのためのドキュメント共有サービスです。
2つの *
または、_
で文言を囲むと、強調(太字・strong)が表現できます。
それは私の**エサ**です。
それは私の**エサ**です。
↓
それは私のエサです。
2つの ~
で文言を囲むと、訂正線(del
)が表現できます。
それは~~いぬ~~トリのエサです。
それは~~いぬ~~トリのエサです。
↓
それはいぬトリのエサです。
3つ以上の *
-
と半角スペースのみの行は、罫線 (hr
) として表現できます。
本文終わり。
---
Enjoy! (\\( ⁰⊖⁰)/) from esa.io
本文終わり。
---
Enjoy! (\\( ⁰⊖⁰)/) from esa.io
↓
本文終わり。
Enjoy! (\( ⁰⊖⁰)/)
インラインのコードは、`<code>` タグです。
インラインのコードは、`<code>` タグです。
↓
インラインのコードは、<code>
タグです。
``` $ git push origin master ```
↓
$ git push origin master
$ git push origin master
```ruby def esa puts "(\\( ⁰⊖⁰)/)" end ```
↓
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 '(\( ⁰⊖⁰)/)'
gem 'rails'
gem 'esa'
puts '(\( ⁰⊖⁰)/)'
```math
e^{i \pi} = -1
```
```math
e^{i \pi} = -1
```
$a = \\{1, 2, 3\\}$
$a = \\{1, 2, 3\\}$
$a = \{1, 2, 3\}$
※ inlineMathはmathコードブロックが含まれている記事ページもしくは #math タグが付いている記事ページで有効です。
```uml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
```
```uml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
```
| アイテム名 | 値段 |
| ------------ | ------------- |
| いぬのえさ | 250円 |
| とりのえさ | 128円 |
| アイテム名 | 値段 |
| ------------ | ------------- |
| いぬのえさ | 250円 |
| とりのえさ | 128円 |
↓
アイテム名 | 値段 |
---|---|
いぬのえさ | 250円 |
とりのえさ | 128円 |
💡 参考: release_note/2015/01/24/テーブル記法を書きやすくしました - docs.esa.io
- [ ] TODO
- [x] TODO
- [x] DONE
- [ ] TODO
- [ ] TODO
- [x] DONE
↓
:emoji:
で、絵文字が表示できます。詳しくはEmoji cheat sheet 参照下さい 🍣 🐥 🐦
絵文字は投稿タイトルや見出しでも利用できます。
@USERNAME
でユーザーに対してメンションが送れます。メンションが送られると画面右上の通知欄から通知されます。
@
を入力すると、チーム内のメンバーがサジェストされます。
#
から入力すると、チーム内の投稿がサジェストされ、楽にリンクが投稿できます。
\
でMakdownで使われる記号がエスケープできます。
\# ほげ
\- hoge
\\hoge
(\\( ⁰⊖⁰)/)
\# ほげ
\- hoge
\\hoge
(\\( ⁰⊖⁰)/)
↓
# ほげ
- hoge
\hoge
(\( ⁰⊖⁰)/)
脚注を付けたい場所にこのように書きます→ [^1]
[^1]: ここに脚注の内容を書きます
esa.io の Markdown 記法のうち、よく使うものを紹介します # 見出し `#` を行頭に付けることで、見出しになります。 `#` の数と見出しの階層が対応します。 ``` # これは h1 タグです ## これは h2 タグです ### これは h3 タグです #### これは h4 タグです ``` ↓ # これは h1 タグです ## これは h2 タグです ### これは h3 タグです #### これは h4 タグです # 箇条書き 箇条書きリストは、 `-` `*` のどれかを入力し、半角スペースまたはタブを挿入します。 半角スペースまたはタブを行頭に挿入すると、箇条書きが入れ子になります。 ``` - リスト 1 - リスト 2 - リスト 2a - リスト 2a1 - リスト 2b ``` ↓ - リスト 1 - リスト 2 - リスト 2a - リスト 2a1 - リスト 2b # 番号付きリスト 番号付きリストは、 `<数字>.`を入力し、半角スペースまたはタブを挿入します。どの数字を入力しても、番号付けは自動で行われます。 半角スペースまたはタブを行頭に挿入すると、リストが入れ子になります。 ``` 1. foo 1. bar 1. baz 1. aaa 2. bbb 3. ccc ``` ↓ 1. foo 1. bar 1. baz 1. aaa 2. bbb 3. ccc # リンク `[表示テキスト](URL)` でリンクになります ``` [esa.io (\\( ⁰⊖⁰)/) ](https://esa.io) ``` ↓ [esa.io (\\( ⁰⊖⁰)/) ](https://esa.io) # 画像 `![代替テキスト](画像URL)` で画像が貼れます ``` ![patapata (\\( ⁰⊖⁰)/)](https://img.esa.io/uploads/production/pictures/105/3203/image/378bedb1186931ecfa019e92dafc1692.gif) ``` ↓ ![patapata (\\( ⁰⊖⁰)/)](https://img.esa.io/uploads/production/pictures/105/3203/image/378bedb1186931ecfa019e92dafc1692.gif) # 引用 行頭に `>` を挿入すると引用(blockquote)として表示できます。 ``` esa.io にはこのように書いてあります。 > esa.io は「情報を育てる」という視点で作られた、 > 小さな開発チームのためのドキュメント共有サービスです。 ``` ↓ esa.io にはこのように書いてあります。 > esa.io は「情報を育てる」という視点で作られた、 > 小さな開発チームのためのドキュメント共有サービスです。 # 強調(太字) 2つの `*` または、`_`で文言を囲むと、強調(太字・strong)が表現できます。 ``` それは私の**エサ**です。 ``` ↓ それは私の**エサ**です。 # 訂正線 2つの `~`で文言を囲むと、訂正線(`del`)が表現できます。 ``` それは~~いぬ~~トリのエサです。 ``` ↓ それは~~いぬ~~トリのエサです。 # 罫線 3つ以上の `*` `-` と半角スペースのみの行は、罫線 (`hr`) として表現できます。 ``` 本文終わり。 --- Enjoy! (\\( ⁰⊖⁰)/) from esa.io ``` ↓ 本文終わり。 --- Enjoy! (\\( ⁰⊖⁰)/) # コード ## インライン表示 ``` インラインのコードは、`<code>` タグです。 ``` ↓ インラインのコードは、`<code>` タグです。 ## コードブロック表示 <pre> ``` $ git push origin master ``` </pre> ↓ ``` $ git push origin master ``` ## シンタックスハイライト <pre> ```ruby def esa puts "(\\( ⁰⊖⁰)/)" end ``` </pre> ↓ ```ruby def esa puts "(\\( ⁰⊖⁰)/)" end ``` ※現在 esaでは [rouge](https://github.com/jneen/rouge)というライブラリを使用しております。対応言語一覧は[こちら](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers)です。 ## ファイル名表示 <pre> ```ruby:Gemfile gem 'rails' gem 'esa' ``` ```ruby:tori.rb puts '(\( ⁰⊖⁰)/)' ``` </pre> ```ruby:Gemfile gem 'rails' gem 'esa' ``` ```ruby:tori.rb puts '(\( ⁰⊖⁰)/)' ``` ## 数式 ### mathコードブロック ```math e^{i \pi} = -1 ``` ```math e^{i \pi} = -1 ``` ### inlineMath $a = \\{1, 2, 3\\}$ $a = \\{1, 2, 3\\}$ ※ inlineMathはmathコードブロックが含まれている記事ページもしくは #math タグが付いている記事ページで有効です。 # UML ([PlantUML](http://plantuml.com/)) ```uml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response ``` ```uml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response ``` # テーブル ``` | アイテム名 | 値段 | | ------------ | ------------- | | いぬのえさ | 250円 | | とりのえさ | 128円 | ``` ↓ | アイテム名 | 値段 | | ------------ | ------------- | | いぬのえさ | 250円 | | とりのえさ | 128円 | :bulb: 参考: [release_note/2015/01/24/テーブル記法を書きやすくしました - docs.esa.io](https://docs.esa.io/posts/54) # タスクリスト ``` - [ ] TODO - [ ] TODO - [x] DONE ``` ↓ - [ ] TODO - [ ] TODO - [x] DONE # 絵文字 `:emoji:` で、絵文字が表示できます。詳しくは[Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) 参照下さい :sushi: :hatched_chick: :bird: 絵文字は投稿タイトルや見出しでも利用できます。 # メンション `@USERNAME` でユーザーに対してメンションが送れます。メンションが送られると画面右上の通知欄から通知されます。 `@`を入力すると、チーム内のメンバーがサジェストされます。 ![スクリーンショット 2015-01-18 21.40.14.png](https://img.esa.io/uploads/production/pictures/105/3222/image/e89349da4600b6f4967462773d803384.png) # チーム内投稿へのリンク `#` から入力すると、チーム内の投稿がサジェストされ、楽にリンクが投稿できます。 ![スクリーンショット 2015-01-18 21.44.12.png](https://img.esa.io/uploads/production/pictures/105/3223/image/84cc4697e5ffb7110f31597fff1a2fb8.png) # エスケープ `\ ` でMakdownで使われる記号がエスケープできます。 ``` \# ほげ \- hoge \\hoge (\\( ⁰⊖⁰)/) ``` ↓ \# ほげ \- hoge \\hoge (\\( ⁰⊖⁰)/) # 脚注記法 `脚注を付けたい場所にこのように書きます→ [^1]` `[^1]: ここに脚注の内容を書きます` :bulb: 参考: [#38: release_note/2014/12/24/脚注記法に対応しました :christmas_tree: :santa:](/posts/38)
esa.io の Markdown 記法のうち、よく使うものを紹介します
#
を行頭に付けることで、見出しになります。 #
の数と見出しの階層が対応します。
# これは h1 タグです
## これは h2 タグです
### これは h3 タグです
#### これは h4 タグです
↓
箇条書きリストは、 -
*
のどれかを入力し、半角スペースまたはタブを挿入します。
半角スペースまたはタブを行頭に挿入すると、箇条書きが入れ子になります。
- リスト 1
- リスト 2
- リスト 2a
- リスト 2a1
- リスト 2b
↓
番号付きリストは、 <数字>.
を入力し、半角スペースまたはタブを挿入します。どの数字を入力しても、番号付けは自動で行われます。
半角スペースまたはタブを行頭に挿入すると、リストが入れ子になります。
1. foo
1. bar
1. baz
1. aaa
2. bbb
3. ccc
↓
[表示テキスト](URL)
でリンクになります
[esa.io (\\( ⁰⊖⁰)/) ](https://esa.io)
![代替テキスト](画像URL)
で画像が貼れます
![patapata (\\( ⁰⊖⁰)/)](https://img.esa.io/uploads/production/pictures/105/3203/image/378bedb1186931ecfa019e92dafc1692.gif)
↓
行頭に >
を挿入すると引用(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
e^{i \pi} = -1
```
$a = \\{1, 2, 3\\}$
$a = \{1, 2, 3\}$
※ inlineMathはmathコードブロックが含まれている記事ページもしくは #math タグが付いている記事ページで有効です。
```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
↓
:emoji:
で、絵文字が表示できます。詳しくはEmoji cheat sheet 参照下さい 🍣 🐥 🐦
絵文字は投稿タイトルや見出しでも利用できます。
@USERNAME
でユーザーに対してメンションが送れます。メンションが送られると画面右上の通知欄から通知されます。
@
を入力すると、チーム内のメンバーがサジェストされます。
#
から入力すると、チーム内の投稿がサジェストされ、楽にリンクが投稿できます。
\
でMakdownで使われる記号がエスケープできます。
\# ほげ
\- hoge
\\hoge
(\\( ⁰⊖⁰)/)
↓
# ほげ
- hoge
\hoge
(\( ⁰⊖⁰)/)
脚注を付けたい場所にこのように書きます→ [^1]
[^1]: ここに脚注の内容を書きます