Markdown
https://www.markdown.jp/what-is-markdown/
Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつで、見出し、箇条書きなどの書式を簡単な記号を使ってプレーンテキスト形式で書くことができます。John Gruber(ジョン・グルーバー)によって2004年に開発・公開されました。
Wikiの記法、READMEファイルの記述、電子メールにおいてプレーンテキストを装飾する際に使う記法などがこれと同様のものです。IT・Webの分野では・・というより、これからの社会では、情報共有に必須の「テクニカル・スキル」と言えます。
- テキストエディタでプレーンテキストとして作成
- 拡張子は .md
チートシート
- https://packetlife.net/media/library/16/Markdown.pdf (標準語)
- https://packetlife.net/media/library/17/MediaWiki.pdf (MediaWiki方言)
サンプルファイル
.md ファイルを表示するには
- Atomの場合、mdファイルの編集時にカラー区分されるとともに
CTRL + SHIFT + m
でプレビュー表示可能です。 - Firefoxの場合、Markdown Viewer アドオンを追加
- Chromeの場合、Markdown Preview Plus 拡張を追加
.md ファイルの編集に適した環境は
プレーンテキストなので、使い慣れたテキストエディタを利用するのが良いでしょう。
- Atom(OpenSource):Markdownプレビュー機能があります。
- Marp:Markdownでスライドを作ることができます。
- StackEdit:オンラインのエディタです。
記法
見出し
行頭に「#」をつけることで、見出しに変換されます。
# 見出し1 ## 見出し2 ### 見出し3 #### 見出し4
箇条書き
行頭に [ * ] / [ + ] / [ - ] のいずれかで Disc型リスト(ul)になります。
(空行) * リスト項目1 + リスト項目2 - リスト項目3 (空行)
行頭に [ 1 ] , [ 2 ] , [ 3 ] ...を入れるとDecimal型リスト(ol)になります。
(空行) 1. リスト項目1 2. リスト項目2 3. リスト項目3 (空行)
以下のように TAB でインデントをとるとネストすることが可能です。
- リスト1 - ネスト リスト1_1 - ネスト リスト1_1_1 - ネスト リスト1_1_2 - ネスト リスト1_2 - リスト2 - リスト3
テキスト装飾
[ * ] または [ _ ] で囲んだ範囲がイタリック体になります。
*イタリック* _イタリック_
[ * ] または [ _ ] を2つ重ねて囲んだ範囲が太字になります。
**太字** __太字__
[ ~ ]( チルダ)を2つ重ねて囲んだ範囲に取り消し線がつきます。
~~定価 1,000円~~
表組
以下のように縦ストロークで表組が可能です。
|見出し1|見出し2| |-|-| |内容1-1|内容1-2| |内容2-1|内容2-2|
リンク
リンクしたい文字列を [ ](隅カッコ)で+リンク先URLを
[Google](http://www.google.com)
引用
行頭に [ > ] で引用になります。複数行にまたがる場合 各行に [ > ]。
>やまとうたは、人の心を種として、万の言の葉とぞなれりける。 >世の中にある人、ことわざ繁きものなれば、心に思ふことを、 >見るもの聞くものにつけて、言ひ出せるなり。
ソースコードブロック
[ ` ](バッククォート)を使うと、HTML, CSS などのソースコードが表示可能です。この記号は [ ' ](シングルクォート)ではありません。キーボード上では @ のところにあります。[SHIFT]+[@] で出ます。
`<h1>Sample</h1>`
https://ja.wikipedia.org/wiki/Markdown
関連記事
- XMLHttpRequest
Markdownを JavaScript で読み込んで表示するサンプル