Skip to content

Instantly share code, notes, and snippets.

@pchw
Created August 12, 2014 07:26
Show Gist options
  • Save pchw/f91aeb54cdddd5eae3b9 to your computer and use it in GitHub Desktop.
Save pchw/f91aeb54cdddd5eae3b9 to your computer and use it in GitHub Desktop.
マークダウン入門

Markdown入門

Markdownはただのテキストでありながら,構造的な文章を書くための記法です. 装飾を表現するための手法が最低限しか無いため,きちんとした文章を手軽に書くための記法として最適です.

また,HTMLなどに変換する際にきちんとマークアップされるため綺麗な見た目にして表示することも容易です.

議事録・メール・GitHub上での議論など様々なところで見やすく構造的な文章を書くにあたって大いに役立ちます.

Markdownとは

Markdown - Wikipedia -

Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。

Markdown はHTMLなどのようにソースファイルと表示された見た目が違うマークアップ言語の一つです. しかし,HTMLのようにそのまま読めないような難解なものではなく,ソースファイルでもそのまま読むことが出来るのが利点です.

例えば以下のものがMarkdownで書かれたソースファイルです

Yo アプリのインストール 〜 Sign Up
============

さて、ここからは Yo API を使うまでの手順を説明していきます。

最初に、Yo のアプリをインストールします。

- [Yo - iOS](https://itunes.apple.com/jp/app/yo./id834335592?mt=8)
- [Yo - Android](https://play.google.com/store/apps/details?id=com.justyo&hl=ja)

これが解釈されて,表示されると 表示されたMarkdown

このようになります.

はじめに挙げたソースファイルでも問題なく読めたと思います.

Markdownの文法

Google Documentのようにエディタの上のほうにあるBボタンを押すと太字にしてくれるような高性能なMarkdownエディタもあるのですが,Markdownの文法は難しくないため覚えてしまったほうが早いです.

覚えてしまえば,エディタはいつものものを使えばよいので,メモ帳でも書くことができます. メモ帳というのはWindowsに初期から入っている超低性能なエディタのことです

章・節のヘッダ

文頭を#で始めると,その行はヘッダになります. 章タイトルや節タイトルに使います.

例文

# はじめに

本文本文本文本文本文

斜体・太字

文字を*_で囲むことで斜体・太字を表現できます. *斜体*のように1個なら斜体です. **太字**のように2個なら太字です.

例文

これは*斜体*です.
これは**太字**です

リスト

文頭を-で始めると,その行はリストになります. 次の行も続けて-で始めると,前の行と続いてリストになります. 番号を付けたリストを作りたい場合は,文頭を1.のように数字とピリオドの組で始めることで表現できます.

例文

# すきなもの
1. りんご
1. みかん
1. ぶどう

# きらいなもの
- ばなな

引用

文頭を>から始めると,その行は引用文となります. リストと同じように次の行も続けて>で始めることで,同じ塊としての引用を意味します.

例文

走れメロスは

> メロスは激怒した。必ず、かの邪智暴虐じゃちぼうぎゃくの王を除かなければならぬと決意した。メロスには政治がわからぬ。
> メロスは、村の牧人である。笛を吹き、羊と遊んで暮して来た。

という記述から始まります.

Markdownエディタ

ここに挙げるMarkdownエディタは,無料で利用できます. また,リアルタイムで綺麗にプレビューする機能も付いているので便利です.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment