Markdownのススメ

「MkDocs」や「Pandoc」で、MkDocsからいろいろなファイル形式変換する仕組みを取り上げました。こんばんわ、Web担当 神凪です。
紙面でも分かりやすいMarkdown、導入コスト・・・教育はそれほど高くありません。紙面でも割と多く使う記述が多数含まれているためです。
そんなわけでNCEで書く蓄積文書はほぼMarkdown式。この記事すらMarkdownです。
紙でもテキストファイルでも、もちろんMarkdown対応アプリでも読みやすい。字が汚いとか別ですよ?

Excel? あれは文書ではなく表計算ですっ

Markdownとは?

あらためてMarkdownとは。
一種の文章の書き方です。 記号を駆使することで文章構造を表現します。
たとえば “-” で箇条書きリストを表記したり、**テキスト** でテキストを強調したり。

テキストメールを使っている場合、割とよく使う方法ですね!
そのため、すべての表記がわからなくとも、少し知っているだけでもうMarkdownユーザです。
おめでとうございます!

記法について

Markdownには書き方のルールがあります。
Markdownという形式になっている以上、当然ではあるのですが。

詳細はいろいろなサイトにお譲りするとして。
でよく使う表記を取り上げます。

Type 書き方 HTML出力すると… 備考
ヘッダ Lv1 # Header1 <h1>Header1</h1>
ヘッダ Lv2 ## Header2 <h2>Header2</h1>
ヘッダ Lv3 ### Header3 <h3>Header3</h1>
ヘッダ Lv4 #### Header4 <h4>Header4</h1> Lv6まで対応するが、文字の大きさ考えると微妙
改行 (半角スペース2つ) </br>
太字 **テキスト** <strong>テキスト</strong> *の代わりに_(アンダースコア)でも良い
斜体 *テキスト* <em>テキスト</em> *の代わりに_(アンダースコア)でも良い
太字斜体 ***テキスト*** <strong>テキスト</strong> *の代わりに_(アンダースコア)でも良い
リンク [Link](http://) <a href=”http://www” >リンク</a>
イメージ ![Image](http://www/image.jpg) <img src=”http://www” /> 基本形はリンクと同じ。
引用 > 引用文 <blockquote>引用文</blockquote> テキストメールでよく見るアレ
箇条書きリスト – List1
– List2
– List3
<ul><li> List1</li><li>List2</li><li>List3</li></ul> -の代わりに*(アスタリスク)でも良い
番号付きリスト 1. List1
2. List2
3. List3
<ol><li> List1</li><li>List2</li><li>List3</li></ol> 1. 1. 1.と進めてもHTML変換時に1. 2. 3.に変換してくれるアプリが多い
水平線 ————— </hr>
文章内コード記述 dirコマンドを入力しよう <code>dirコマンドを入力しよう</code>
コードブロック記述 ```
#!/bin/bash
number=1
echo $number
```
<code>
#!/bin/bash
number=1
echo $number
</code>

おわりに

いかがでしたか?
Markdownにはもっと多くの記述方がありますが、上記のわかりやすい記述をまずは取り込む。
そして順次できることを増やしていってMarkdownに慣れていく。簡単にすぐに使えるようになりますよ!

コメントを残す

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください