コードブロックと引用 ― 記号をそのまま見せる

目安学習時間 5分

教材

そのまま見せたいときに囲む

Markdownは記号に意味を持たせる書き方なので、記号そのものを見せたいときは「これは記法ではない」と伝える必要があります。 そのための仕組みがコードブロックです。

バッククォート(`)を3つ並べた行ではさみます。

ここに書いたものは、記号もそのまま表示されます。
# これは見出しになりません。

エラーメッセージ、コマンド、設定ファイルの中身を貼るときは必ずこれを使ってください。囲まずに貼ると、記号が勝手に解釈されて元と違うものが表示されます。

文の途中ならバッククォート1つ

文中で短く触れるときは、バッククォート1つではさみます。

設定ファイルの `config/database.yml` を開いてください。

ファイル名やコマンド名がふつうの文字と区別され、コピーしやすくなります。

言語を書くと色が付く

最初のバッククォート3つのうしろに言語名を書くと、多くのツールで色分けされます。

```ruby
puts 'Hello'

#### 引用は `>`

他の人の発言や既存の文章を引くときは、行の先頭に `>` を置きます。

表示が崩れていると連絡がありました

こちらで確認したところ、画面幅が375px以下のときだけ起きていました。
```

引用と自分の見解が視覚的に分かれるので、どこまでが人の言葉で、どこからが自分の判断なのかが読み手に伝わります。

このレクチャーで学ぶこと

  • バッククォート3つで囲む
  • 文中のコードは1つで囲む
  • 引用は>を使う

質問

まだ質問は投稿されていません。

質問投稿

ログイン後に質問の投稿ができます。