Markdown
軽量マークアップ言語として主にエンジニア界隈で流行っている記法です
sta.icon筆者も多用しています
以下、なんとなくイメージを掴むための解説を書いてみました
解説1:マークアップ言語とは
マークアップ言語とは何?
メモ帳のようなプレーンテキストだと書きやすいが、読みづらい
Wordのようなリッチテキストだと読みやすいが、書くのが大変
Wordなどの有料エディタをそもそも用意しなきゃいけない
ビジュアル(文字装飾やレイアウトなど見た目)を整えないといけない
しばしば見た目に気を取られて、文章という内容に集中しづらい
……
折衷案は無い?
それがマークアップ言語
マークアップ言語では以下のアプローチを取る
書く時はメモ帳みたいにプレーンテキストで書く(書きやすい)
読む前に、何らかの変換システムで「読みやすい形式」に変換する
読む時は変換された形式を読む(読みやすい)
主な例
HTML
軽量マークアップ言語とは何?
より書きやすいマークアップ言語
HTML
とても書きづらい
太字を書くには <strong>太字</strong> こうする必要がある
<strong></strong> ← 文法をこんなに書かないといけない
これではしんどすぎる
もっと楽な記法を採用するべきでは?
それが軽量マークアップ言語
Markdownとは
軽量マークアップ言語の一種
軽量マークアップ言語の中では非常に優秀
書きやすい、わかりやすい、覚えやすい
対応しているシステムが多い
はてなブログで使える
Trelloなどタスク管理ツールで使える
……
解説2:Markdownはどんな感じの文法?
Markdownの基本的な書き方
code:markdown_example.md
# 見出し
本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文
本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文
本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文本文
# 主な文法
## リスト
- 箇条書きです
- 箇条書きです
- サブ項目はスペース4つ空けます
## 文字装飾
基本的には **太字** だけです
## リンク
かなり易しく書きやすいことがわかるかと思います
sta.icon他のマークアップ言語使っていないとピンと来ないかもしれませんが
Markdownは画期的なんです!
HTMLの太字と比べてください
<strong>太字</strong>
Markdownでは **太字** これだけです
解説3:Markdownの書き方に合わせるということ
Markdownにはいくつか哲学やお作法があり、素直に従うのがベターです
哲学1:改行しない
文章を書く際、途中で見やすくするために改行を入れることがあります
code:改行の例.md
文章を書く際、途中で見やすくするために
改行を入れることがあります
これはご法度です
Markdownは「段落」という単位で文章を書き、この段落内では改行は一切しません
code:こうするべきです.md
文章を書く際、途中で見やすくするために改行を入れることがあります。多少行が長くなったとしても、段落内では改行を入れてはいけません。なぜなら、長い行を折り返す「見た目」の調整は私達の仕事ではないからです。
私達は書くことに集中します
見た目の調整はMarkdownを解釈し表示するシステムがやります
この場合、このScrapboxですね
上記を見てもわかるとおり、ちゃんと折り返されていますよね
哲学2:見出しを使う
文章を構造化するためにも、見出しを使ってください
code:見出しの例.md
# 大見出し
## 中見出し1
### 小見出し1
### 小見出し2
## 中見出し2
これは以下のような構造になります
大見出し
中見出し1
小見出し1
小見出し2
中見出し2
見出しをつけておくと、Markdownを解釈・表示するシステム側で読みやすくなります
目次がつく
大きなフォントでデザインで表示され、視覚的にわかりやすい
……
sta.iconいったんこのへんで
Markdownについてざっくりとイメージが湧きましたら幸いです