読者です 読者をやめる 読者になる 読者になる

美味しいものが食べたい

食べてる時と寝てる時が幸せ

Markdown記法

早速仕事のこと。

前職でRedmineとかの起票系のツールとかslackもだけど、あと社内のwikiとかそういうやつでちょいちょい出てきていた、「Markdown記法」。

よく使うやつだけちょちょっとやっていたものの、実際わたしは、コミットしましたーとか、jsでclassこれ追加してもらうと切り替わるcss作ってますーとかそんなんばっかだったんですが、今回また使いそうなのでちょっとやってみようと思い調べました。

 

Markdown記法とはなんぞ?

Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。本来はプレーンテキスト形式で手軽に書いた文書からHTMLを生成するために開発されたものである。しかし、現在ではHTMLのほかパワーポイント形式やLaTeX形式のファイルへ変換するソフトウェア(コンバータ)も開発されている。各コンバータの開発者によって多様な拡張が施されるため、各種の方言が存在する。

とのこと。

参照はwikipediaです。

Markdown - Wikipedia

 

てことで、まぁ普段からHTMLに馴染んでればそんな難しいもんでもないんですが、

使わないと忘れるので、主要そうなのだけメモにまとめた。

pre>codeでくくるのhtml編集からだと超絶めんどいんだけど、これちゃちゃっとやる方法ないの?途中でめんどなって諦めた。

→設定からマークダウン記法に変更できたのでこれからはそっちで。ただこれは設定変更前だからいじれなかった。。。つらみ。

 

・見出し

    # 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

※#の数がh1の数字と呼応する感じ


・箇条書きリスト

    - リスト1
   - ネスト リスト1_1
      - ネスト リスト1_1_1
      - ネスト リスト1_1_2
   - ネスト リスト1_2
- リスト2
- リスト3



・番号付きリスト

    1. 番号付きリスト1
    1. 番号付きリスト1_1
    1. 番号付きリスト1_2
1. 番号付きリスト2
1. 番号付きリスト3

 


・引用

    >ほにょほにょ。
> ほにょほにょ。ほにょほにょ。ほにょほにょ。



・二重引用

    >ほにょほにょ。
> ほにょほにょ。ほにょほにょ。ほにょほにょ。
>> ふにょふにょ。ふにょふにょ。ふにょふにょ。
>> ふにょふにょ。ふにょふにょ。ふにょふにょ。


・pre記法(スペース4 or タブ)

    # Tab
  class Hoge
    def hoge
      print 'hoge'
    end
  end
---
    # Space
    class Hoge
      def hoge
        print 'hoge'
      end
    end



・code記法

    インストールコマンドは `gem install hoge` です


・強調:<em>

    normal *italic* normal
normal _italic_ normal


・強調:<strong>

    normal **bold** normal
normal __bold__ normal


・強調:<em> + <strong>

    normal ***bold*** normal
normal ___bold___ normal


・水平線

    ***
___
---
*    *    *


・リンク

    [Google先生](https://www.google.co.jp/)


・定義参照リンク

    [こっちからgoogle][google]
その他の文章
[こっちからもgoogle][google]


GitHub Flavored Markdown(GFM)


GitHub Flavored Markdown(GFM)GitHubの独自仕様を加えたMarkdown記法。
以降、GFMと記載します。


・GFM:リンクテキスト簡易記法

    https://www.google.co.jp/
    


・GFM:取り消し線

    ~~取り消し線~~


・GFM:pre記法(チルダ×3)

    ~~~
class Hoge
    def hoge
        print 'hoge'
    end
end
~~~


・GFM:pre記法(シングルクォート×3)

    ```
class Hoge
  def hoge
    print 'hoge'
  end
end
```


・GFM:pre記法(シンタックスハイライト)

    ~~~ruby
class Hoge
  def hoge
    print 'hoge'
  end
end
~~~

※~~~のあとには、シンタックス言語名を記述する


・GFM:表組み

    |header1|header2|header3|
|:--|--:|:--:|
|align left|align right|align center|
|a|b|c|


・GFM:ページ内リンク

    ## <i class="fa fa-cube" style="font-size:1em;"></i> menu
* [to header1](#header1)
* [to header2](#header2)
<!-- some long code -->
[return to menu](#menu)
### header1
### header2