markdown - y-d-yamashita/docs GitHub Wiki

Markdown記法チートシート Kobitoで利用可能なMarkdown記法のチートシートです。

Markdown記法の原文については、[Daring Fireball: Markdown Syntax Documentation] (http://daringfireball.net/projects/markdown/syntax.php)をご覧下さい。 また、コードに関する記法はGitHub Flavored Markdownに準拠しています。

Format Text - テキストの装飾

Headers - 見出し

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

Emphasis - 強調

  • *これはイタリック体です*
  • _これもイタリック体です_
  • _これは_イタリック体になりません
  • **これは太字です**
  • __これも太字です__

Lists - リスト

Disc型

  • 文頭に「*」「+」「-」のいずれかを入れるとDisc型リストになります
  • 要点をまとめる際に便利です
  • リストを挿入する際は、リストの上下に空行がないと正しく表示されません
  • リストの中にリストを記述したい時は4space開けないと行けません

Decimal型

  1. 文頭に「数字.」を入れるとDecimal型リストになります
  2. 1.2.3.と入れていくといい具合です
  3. リストを挿入する際は、リストの上下に空行がないと正しく表示されません

Blockquotes - 引用

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

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

Horizontal rules - 水平線

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

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

Links - リンク

[リンクテキスト](URL)

例

Markdown: [Qiita](http://qiita.com) 結果: Qiita

タイトル無しのリンクは以下のになります

[リンクテキスト](URL)

Images - 画像埋め込み

![代替テキスト](画像のURL)

リンクと同じでタイトルは無記入でも大丈夫です

例

Markdown: ![github](http://cdn.gregrickaby.com/wp-content/uploads/2012/03/github-logo.png) 結果: github

その他

バックスラッシュ[\]をMarkdownの前に挿入することで、Markdownをエスケープ(無効化)することができます。

例

# H1 エスケープされています

Code - コードの挿入

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

(空行) ```ruby puts 'The best app to log and share programming knowledge.' ``` (空行)

結果

puts 'The best app to log and share programming knowledge.'

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

` puts 'Kobito'` はプログラマのための知識記録アプリです。

結果

puts 'Kobito' はプログラマのための知識記録アプリです。

シンタックスハイライト可能な言語

Kobitoで現在シンタックスハイライト可能な言語/ファイル形式は以下です。 基本的には上記のフォーマットに従って言語名/ファイル形式を小文字で書くと適用されますが、例外的なものについては下記の括弧で括った中の表記を利用してください。

例: C++のハイライト ```cpp print("hello\n"); ```

Bash, C#(cs), C++(cpp), CSS, Diff, HTML, XML, Ini, Java, Javascript, PHP, Perl, Python, Ruby, SQL, 1C, AVR Assembler(avrasm), Apache, Axapta, CMake, DOS .bat(dos), Delphi, Django, Erlang, Erlang, REPL, Go, Haskell, Lisp, Lua, MEL, Nginx, Objective C(objectivec), Parser3, Python, profile, Scala, Smalltalk, TeX, VBScript, VHDL, Vala