Skip to content

Instantly share code, notes, and snippets.

@wreulicke
Created September 6, 2016 18:51
Show Gist options
  • Save wreulicke/dd8c0b74d07f5cdd6627330b56eb76ce to your computer and use it in GitHub Desktop.
Save wreulicke/dd8c0b74d07f5cdd6627330b56eb76ce to your computer and use it in GitHub Desktop.
kobitoのチートシート

Markdownチートシート Kobitoでは、プレーンテキストを手軽に装飾してくれる、Markdownという記法を使うことができます。 以下にKobitoで使えるMarkdown記法について説明します。

テキストの装飾

見出し - Headers

これはH1タグです

これはH2タグです

これはH6タグです

# これはH1タグです
## これはH2タグです
###### これはH6タグです

強調 - Emphasis

  • 太字を使うには __ か ** で囲みます。
  • _イタリック体_を使うには _ か * で囲みます。

_イタリック体_を使うには _ か * で囲みます。
**太字**を使うには __ か ** で囲みます。

打ち消し線 - Strikethrough

打ち消し線を使うには ~~ で囲みます。 打ち消し

打ち消し線を使うには ~~ で囲みます。 ~~打ち消し~~

リスト - Lists

  • 文頭に「*」「+」「-」のいずれかを入れるとリストになります
  • 要点をまとめる際に便利です
  • リストを挿入する際は、 リストの上下に空行がないと正しく表示されません。また「*」「+」「-」の後には半角スペースが必要です

* 文頭に「*」「+」「-」のいずれかを入れるとリストになります
* 要点をまとめる際に便利です
* リストを挿入する際は、 **リストの上下に空行がないと正しく表示されません。また「*」「+」「-」の後には半角スペースが必要です**

順序付きリスト - Ordered Lists

  1. 文頭に「数字.」を入れると順序付きリストになります
  2. 後からの挿入/移動を考慮して、1. 2. 3. と順番にするのではなく、1. 1. 1. という風に同じ数字にしておくといい具合です。
  3. リストを挿入する際は、 リストの上下に空行がないと正しく表示されません。また「数字.」の後にはスペースが必要です

1.  文頭に「数字.」を入れると順序付きリストになります
2.  後からの挿入/移動を考慮して、1. 2. 3. と順番にするのではなく、1. 1. 1. という風に同じ数字にしておくといい具合です。
3.  リストを挿入する際は、 **リストの上下に空行がないと正しく表示されません。また「数字.」の後にはスペースが必要です**

リンク - Links

  • [リンクテキスト](URL)
    • リンクを投稿できます。

*Markdown:*  [Qiita](http://qiita.com "Qiita")

結果: Qiita

画像埋め込み - Images

  • ![代替テキスト](画像のURL)
    • 画像を埋め込む
  • Kobitoでは、ドラッグ・アンド・ドロップで画像を埋め込むこともできます。

Markdown: ![Qiita](http://qiita.com/icons/favicons/public/apple-touch-icon.png "Qiita")

結果: Qiita

引用 - Blockquotes

文頭に>を置くことで引用になります。 複数行にまたがる場合、改行のたびにこの記号を置く必要があります。 引用の上下にはリストと同じく空行がないと正しく表示されません 引用の中に別のMarkdownを使用することも可能です。

これはネストされた引用です。

テーブル記法

| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This       |        This |     This     |
| column     |      column |    column    |
| will       |        will |     will     |
| be         |          be |      be      |
| left       |       right |    center    |
| aligned    |     aligned |   aligned    |

# 見やすいように空白をいれて各セル内の文字を揃えていますが、
 実際には空白無しでも認識されます。

上記のように書くと,以下のように表示されます。

Left align Right align Center align
This This This
column column column
will will will
be be be
left right center
aligned aligned aligned

なお2行目の :--- という記号は、: の位置がその列での文字の揃えを表しています。:--- であれば 左揃え になります。

水平線 - Horizontal rules

下記は全て水平線として表示されます

* * *
***
*****
- - -
---------------------------------------


コードの挿入 - Code

たとえば、Rubyで記述したコードをファイル名「qiita.rb」として投稿したいときは、 バッククオート を使用して以下のように投稿するとシンタックスハイライトが適用されます。 コードブロック上下に空行を挿入しないと正しく表示されないことがあります。

(空行)
```ruby:qiita.rb
puts 'The best way to log and share programmers knowledge.'
```
(空行)

結果

puts 'The best way to log and share programmers knowledge.'

また、コードをインライン表示することも可能です。

`puts 'Qiita'` はプログラマのための技術情報共有サービスです。

結果

puts 'Qiita' はプログラマのための技術情報共有サービスです。

インラインコードがn個連続するバッククオートを含む場合、n+1連続のバッククオートで囲みます。

`` `バッククオート` `` や ``` ``2連続バッククオート`` ``` も記述できます。

結果

`バッククオート```2連続バッククオート`` も記述できます。

また本文では一部のHTMLタグも利用可能です。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment