LoginSignup
4
8

More than 5 years have passed since last update.

Markdown記法 サンプル1(ブロック系と引用系)

Last updated at Posted at 2018-08-20

はじめに

初心者中の初心者が初めてMarkDownを使うにあたり、一通り試してみたことをまとめておくための記事。
少し冗長かもしれないですが、復習を兼ねて書いています。(ツッコミあったら是非教えてください)
#本当はこの下に目次書こうと思いましたが、右のエリアで代替できるっぽいので、省略します。
  → 右のエリアがすごいことになっているのですが、どうやってコントロールしたら良いのやら・・・一旦このまま!!
#更にまだ途中だけどあまりにも長くなったので、一旦終了。気が向けば続きとまとめたものを作ります。

書き方

見出し

文章を構造化するための見出し。
文字の前に、#を付けて表現する。
#の数を増やせば、増やしただけ入れ子になり、階層見出しになっていく。(最高で6つまで)

sample.md
#見出し1
##見出し2
###見出し3
####見出し4
#####見出し5
######見出し6

結果

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

見出し5と見出し6はなんだか同じように見える・・・。

箇条書きのリスト

順不同な要素を書き出すときに使う。
文頭に、-*+を付けることで表現できる。
入れ子にも対応しており、記号の前にTabまたは(半角スペース)を入力することでLv違いの箇条書きを表現できる。

記号の後に、(半角スペース)をつけないと、ただ記号を書いただけになるため注意!
もう一つ、箇条書きエリアの上下の行は空白行でないと、箇条書きと認識されないため、注意!

sample.md
- ハイフンでの箇条書き(Lv1)
    - 入れ子ハイフンでの箇条書き(Lv2)
        - 入れ子ハイフンでの箇条書き(Lv3)
            - 入れ子ハイフンでの箇条書き(Lv4)
* アスタリスクでの箇条書き(Lv1)
 * 入れ子アスタリスクでの箇条書き(Lv2)
    * 入れ子アスタリスクでの箇条書き(Lv2)
     * 入れ子アスタリスクでの箇条書き(Lv2)
+ プラスでの箇条書き

結果

  • ハイフンでの箇条書き(Lv1)
    • 入れ子ハイフンでの箇条書き(Lv2)
      • 入れ子ハイフンでの箇条書き(Lv3)
        • 入れ子ハイフンでの箇条書き(Lv4)
  • アスタリスクでの箇条書き(Lv1)
    • 入れ子アスタリスクでの箇条書き(Lv2)
    • 入れ子アスタリスクでの箇条書き(Lv2)
      • 入れ子アスタリスクでの箇条書き(Lv2)
  • プラスでの箇条書き

Lv1→Lv2については半角スペース1つだが、Lv2→Lv3については半角スペースを4つ入れないと認識しない。
何故なのかは、調査不足のためわからない。

Qiitaで記載する場合、Lv2(1つ入れ子)は白抜きの四角で表示され、それ以上の入れ子は黒塗りの四角で表示される。(Lv4何ぞ、入れ子しすぎだ!ということかも)

一度箇条書きとして記載すると、改行後の行でも予め箇条書きの記号が書かれるので、便利(Qiitaのエディタ上は・・・だが)。

段落番号のリスト

順番のある要素を書き出すときに使う。
文頭に、1.を付けることで表現できる。
入れ子にするには、文頭に(半角スペース)を入れる。
これも、段落番号エリアの上下の行は空白行でないと、段落番号と認識されないため、注意!

sample.md
1. 段落番号1(Lv1)
 1. 段落番号1(Lv2)
 1. 段落番号1(Lv2) 
    1. 段落番号1(Lv3)
     1. 段落番号1(Lv4)
     1. 段落番号1(Lv4)
         1. 段落番号1(Lv5)
         1. 段落番号1(Lv5)
              1. 段落番号1(Lv6)
1. 段落番号2(Lv1)
 1. 段落番号2(Lv2)

結果

  1. 段落番号1(Lv1)
    1. 段落番号1(Lv2)
    2. 段落番号1(Lv2)
    3. 段落番号1(Lv3)
      1. 段落番号1(Lv4)
      2. 段落番号1(Lv4)
        1. 段落番号1(Lv5)
        2. 段落番号1(Lv5)
          1. 段落番号1(Lv6)
  2. 段落番号2(Lv1)
    1. 段落番号2(Lv2)

Lv1→Lv2については半角スペース1つだが、Lv2→Lv3などそれ以降については半角スペースを4つ入れないと認識しない。
何故なのかは、調査不足のためわからない。(再び)

引用

引用は古いメールと同じで、>で表す。
入れ子も可能で、>を重ねることで表現できる。
引用ブロックの前後に、空白行を入れる必要がある。(入れないと引用ブロックとみなされる)

sample.md
引用無し
>引用している文章

引用無し(空白行があるので、この直前で引用ブロックが終わる)

>引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。
引用(空白行が入っていないため、引き続き引用ブロック)

>引用している文章(空白行が入っているが、引用記号が入っているため同じ引用ブロック)
>>入れ子引用
>引用している文章(空白行が入っていないため、入れ子引用になっている)
>>>入れ子引用

結果

引用無し

引用している文章

引用無し(空白行があるので、この直前で引用ブロックが終わる)

引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。引用している文章。
引用(空白行が入っていないため、引き続き引用ブロック)

引用している文章(空白行が入っているが、引用記号が入っているため同じ引用ブロック)

入れ子引用
引用している文章(空白行が入っていないため、入れ子引用になっている)

入れ子引用


ブロックの始まりと終わりには空白行、というのがお決まりのパターンだと思い始める。

Code記載(インライン)

文章内にコード(のようなもの)を記載する。
コードとして記載したい文章を `(バッククオート) で囲む。
バッククオートで囲んだ個数(1個/2個)は対応する。

sample.md
文章の中で`Code`として記載する
バッククオートを盛り込みたい場合は、``2つの`で囲むと``間の1つのバッククオートが表示される
`一つのバッククオート` ``2つのバッククオート``

結果

文章の中でCodeとして記載する
バッククオートを盛り込みたい場合は、2つの`で囲むと間の一つのバッククオートは普通に表示
一つのバッククオート 2つのバッククオート


バッククオート表示するのは、MarkDownのエスケープの表記ではうまくいかなかったので、ちょっと迷った。

Code記載(ブロック)

独立したブロックでコードを記載するための表現。
コードとして記載したいエリアを`(バッククオート)3つで囲む。

sample.md
     ```Java:sample.java
     //コメント
     private void test(String str) {
         String text = new String();
     }
     ```

結果

sample.java
//コメント
private void test(String str) {
    String text = new String();
}

バッククオートの後ろにあるJava:sample.java は、(言語の指定):(ファイル名)を意味する。
指定できる言語は、調べきれて無いけれども、メジャーどころであれば問題なく可能。

Code記載のところで3つのバッククオートを記述するには、文頭に空白を4つ入れることで記述できた。
単純に3つバッククオートを入れてしまうとCode記載エリアが終わるだけなので注意。

4
8
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
4
8