【Rails】redcarpet + rouge で使えるMarkdown一覧 | 瀬戸内の雲のように

【Rails】redcarpet + rouge で使えるMarkdown一覧

Posted: 2017-12-19


スポンサーリンク

目次

  • 見出し1
  • !/bin/bash
  • まとめ

    背景

    自分がブログを書く時、いつもmarkdownを忘れてしまうので、自分のために書いておきます。


    (その前に) Markdownとは

    wikipedia さんによると

    Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。
    本来はプレーンテキスト形式で手軽に書いた文書からHTMLを生成するために開発されたものである。

    とのことです。

    要約すると、

    • 難しいHTMLを覚えることなく、誰でも簡単に
    • マークアップ(文章の装飾やリンク等)を使えるようにした

    ものだと私は理解しています。


    前提

    本ブログはRuby on Railsで構築しており、マークダウンには以下のGemを使っています。

    • redcarpet
    • rouge

    ですので、基本的にはこの環境で使えるものと思って頂ければと思います。



    マークダウンで書けること一覧

    自分がよく使うものを書いてます

    • 見出し
    • コードやコマンドのシンタックスハイライト(色付け)
    • リンク
    • 引用
    • 箇条書き
    • 強調表示
    • 取り消し戦



    書き方


    見出し

    以下のように書くと

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

    このように表示されます。

    見出し1

    見出し2

    見出し3

    見出し4



    コードやコマンドのシンタックスハイライト(色付け)

    これは技術系の記事を書く時によく使うと思いますが、以下のように書きます。

    ```bash
    #!/bin/bash
    echo 'Hello world!!'
    ```
    

    このように表示されます。

    #!/bin/bash
    echo 'Hello world!!'
    



    リンク

    # [リンク先名](リンク先URL)
    [yahooです](https://yahoo.co.jp)
    

    こう見えます
    yahooです



    引用

    こう書くと

    >こんにちは。
    先日頂いたメールの
    >>参加者一覧を送ってください。
    
    >についてですが、現在取りまとめを行っております。
    

    こんにちは。
    先日頂いたメールの

    参加者一覧を送ってください。

    についてですが、現在取りまとめを行っております。



    箇条書き

    こう書くと

     - aaa
     - bbb
     - ccc
    

    こう見えます

    • aaa
    • bbb
    • ccc



    強調表示

    2つパターンがあります。

    あいうえおabcde
    *あいうえおabcde*
    **あいうえおabcde**
    

    こう見えます。



    あいうえおabcde
    あいうえおabcde
    あいうえおabcde



    このように、*を1つ付けるか、2つ付けるかで強調表示できます。
    1つの場合、斜体に、2つの場合太字になります。



    取り消し線

    こう書くと

    とっても~~憎たらしい~~かわいい顔ですね
    



    こう見えます


    とっても憎たらしいかわいい顔ですね



    まとめ

    このようにマークダウンを使うことでHTMLタグを書くことなくテキストに装飾を加えることができます。
    (随時更新予定)


    スポンサーリンク




    コメント一覧


    コメントを投稿する


    お名前


    コメント内容





    TOP back