GitHub Flavored Markdown でリストの中に code block を入れる その二

過去記事の続き。リストの中に code block をハイライト付きで表示する方法について。

• ref. clmemo@aka: GitHub Flavored Markdown でリストの中に code block を入れる

GFM の code block

前記事のおさらい。

non-fenced code blocks

コードの前に 4 つのスペースを置いてインデントする

fenced code blocks

コードを ``` で囲む方式。開始部分に言語名を指定すると、コードハイライトしてくれる

前記事では、リストの中でコード・ブロックを置くには

1. non-fenced code blocks しか使えない
2. インデントは 4 ではなく 8 を使う

と紹介した。fenced code blocks ではないので、コード・ハイライトは効かない。

リストの中でコードハイライト

non-fenced code blocks と fenced code blocks を組み合わせることで、リスト中でも (更に入れ子のリスト内でも) コード・ハイライトが出来る。

以下、ataka/emacs-wget の README.md で実際に使っているコードを写す。

1.  make && make install

    ```
    $ tar xzvf emacs-wget-X.YY.tar.gz
    $ cd emacs-wget-X.YY
    $ make
    # make install
    ```

  1. If make fails, put all *.el files into your load-path directory.
2. Put following expressions into your .emacs file.

    ```elisp
    (autoload 'wget "wget" "wget interface for Emacs." t)
    (autoload 'wget-web-page "wget" "wget interface to download whole web page." t)
    ```

3. Setting for Web browser on Emacs:
  1. With emacs-w3m, put the following code into your .emacs:

    ```elisp
    (load "w3m-wget")
    ```

  2. With Emacs/W3, put the following code into your .emacs:

    ```elisp
    (autoload 'w3-wget "w3-wget" "wget interface for Emacs/W3." t)
    ```

4. If wget version is 1.7 or less, put the following code into your .emacs:

    ```elisp
    (setq wget-basic-options '("-v"))
    ```

5. When you write your `.wgetrc`:
  1. `quiet = on`

     Emacs-wget will fail to download.  Put the following into your .emacs:

     ```elisp
     (setq wget-basic-options (cons "-equiet=off" wget-basic-options))
     ```

Brilliant!

あとがき

この書き方は @ClimbAppDev さんに教わった。README が読みやすくなった。ありがとうございます。