Markdown Samples
- see Markdown ・ GitBook Toolchain Documentation
- see Mastering Markdown ・ GitHub Guides
- see Basic writing and formatting syntax - User Documentation
TL;DR
- GitBookのマークダウン記法はGFMに近い
- タスクリスト、絵文字は使えない
- それ以外はほぼ問題ない
Toc
- Headers
- Emphasis
- Lists
- Images
- Links
- Blockquotes
- Inline code
- Syntax highlighting
- Tables
- Task Lists
- Emoji
Headers
Setext-style
header1
======
header2 {#setext-h2}
------
ex
header1
header2
link to Setxt-style header2
Atx-style
# header1 {#atx-h1}
## header2
### header3
#### header4
##### header5
###### header6
ex
header1
header2
header3
header4
header5
header6
link to Atx-style header1
Emphasis
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
~~This text will be crossed out.~~
ex
This text will be italic This will also be italic
This text will be bold This will also be bold
You can combine them
This text will be crossed out.
つまりイタリック、ボールド、その入れ子もできて、打消し線も引ける。
また、イタリックボールドのように記号を変えればくっつけて書ける。
Lists
Unordered
* Item 1
* Item 2
* Item 2a
* Item 2b
- Item 3a
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 3a
Ordered
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
1. Item 3b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
DL
<dl>
<dt>りんご</dt>
<dd>赤いくだもの</dd>
</dl>
- りんご
- 赤いくだもの
DLはそのままマークアップする。
Images


GitBookはsvgだったのでやむなくgoogleロゴに。画像の表示は
ということ。
Links
http://gitbook.com
[GitBook](http://gitbook.com)
[GitBook](http://gitbook.com "GitBook ・ Documentation made easy")
GitBook 画像と同じようにタイトル付が使える
Blockquotes
As Kanye West said:
> We're living the future so
> the present is our past.
As Kanye West said:
We're living the future so the present is our past.
Inline code
変換するには`gitbook build`と打つ
変換するにはgitbook build
と打つ
Syntax highlighting
```javascript
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
```
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
単にインデントするだけでもコードのように表示できる
Tables
see Organizing information with tables - User Documentation
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
Command | Description |
---|---|
git status | List all new or modified files |
git diff | Show file differences that haven't been staged |
Command | Description |
---|---|
git status |
List all new or modified files |
git diff |
Show file differences that haven't been staged |
Left-aligned | Center-aligned | Right-aligned |
---|---|---|
git status | git status | git status |
git diff | git diff | git diff |
Name | Character |
---|---|
Backtick | ` |
Pipe | \ |
Task Lists
GFMの機能なのでGitBookでは使用できないようだ。
- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
- [x] @mentions, #refs, links, formatting, and
tagssupported - [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
Emoji
:simple_smile:
絵文字も使用不可(ドキュメントには不要か)