覚えてしまえばすごく楽！Markdown記法を使ってみよう
Markdown（マークダウン）記法、使ってますか？「README.md」として見掛けたことがあるかもしれません。また、実は気付かずに、Markdownと同じようなテキストの書き方をしていることがあります。基本のいくつかさえ覚えておけばカンタンで、スタイルなどの装飾を気にしなくていいから作業が楽。慣れたら徐々に範囲を広げたり、応用していけばOKです。
Markdown（マークダウン）記法とは？
Markdown記法とは、テキストを構造的に記述する「マークアップ言語」の一つです。特定の記号を使って、段落や見出し、装飾などを自動的に表示できます。内容と構造を分けて扱えばいいので、見出しや本文、箇条書きといったレイアウトを気にせず、素早く文章を入力していくことができます。タグを使ってテキストやリンクの構造を指定するHTMLやXMLも、マークアップ言語の例です。
Markdown記法には、いろいろなルールがありますが、代表的な例だけご紹介します。いろいろなチートシート（表記をまとめた一覧）も豊富にあります。
○主なMarkdown記法のルール
| 種類 | 表記方法 | 表記例 |
|---|---|---|
| 段落 | 空白行 | 1段落目
2段落目 |
| 改行 | 行末に2つ以上の半角スペース | 1行目 （行末に2つ以上の半角スペース） 2行目 |
| 見出し | 行頭に# （#の個数がH1～H6） |
#見出し1 ##見出し2 |
| 強調 | テキストの前後に * または _ | *強調* |
| リスト | 行頭に *または- | * リスト項目1 * リスト項目2 * リスト項目3 |
| 番号付リスト | 行頭に 数字. | 1. リスト項目1 2. リスト項目2 3. リスト項目3 |
| 引用 | 行頭に> | >メールの返信と同じですね |
| ソースコード | テキストの前後に` | `npm run dev` |
| 区切り線 | 3つ以上の * か _ または – | – – – |
| 表 | | で整形 | : で左/中/右揃え – – – – – – – – -: | |
| No | 氏名 | 保有資格 | – – -: | :- – – – – | : | 1 | 佐藤 一郎 | ITサービスマネージャ | |
| 画像 | 行頭に ! |  |
| リンク | [タイトル](リンク先URL) | [運用ナビ](https://un4navi.com/ “システム運用に関する、人気の情報サイト”) |
○Markdownの記述例：
# 運用ナビ
### 人気の記事をご紹介
運用設計、ITIL、ひとり情シスなどが人気
**注目記事はコレだ**
– システム運用だって設計が必須！*設計の視点*が運用担当者を救う！
– *ITILまとめ*：システム運用に直接関係する部分だけサクっとおさらい！
– 仮想化に使う*コンテナ技術*って何？仮想マシンじゃどこがダメなのか？
○変換された例：
運用ナビ
人気の記事をご紹介
運用設計、ITIL、ひとり情シスなどが人気
注目記事はコレだ
- システム運用だって設計が必須！設計の視点が運用担当者を救う！
- ITILまとめ：システム運用に直接関係する部分だけサクっとおさらい！
- 仮想化に使うコンテナ技術って何？仮想マシンじゃどこがダメなのか？
＜PR＞運用エンジニアは忙しい！毎回テキストのレイアウトや見た目の処理に、手間を掛けてる場合じゃない！Markdownは覚えて、システム運用も「UOM」を使って効率化・自動化しましょう！詳しくはこちらへ
意外と身近なところで使えるMarkdown記法
Markdown記法は、いろいろなアプリケーションやサービスで広く採用されていて、ツールやサービスも豊富です。機能面で見ても、シンタックスハイライトやリアルタイムプレビュー、複数人でのコラボレーションができるサービスなど、それぞれに特長があります。また、スマホ/タブレット用アプリや、Chromeの拡張機能があったり、シンプルなスライドショーができるJavaScriptフレームワークやコンバータなども充実。
また、例えばSlackでは、Markdown記法は採用されていませんが、よく似た記述方法が使えます。また、Googleドキュメントは、アプリやアドオンでMarkdown記法が使えるようになります。ちなみに、この「運用ナビ」のサイトで使っているWordPressも、5.0からデフォルトでMarkdown記法が使えます。
○こんなシーンで
- 議事録をリアルタイムで
- ちょっとしたメモやブログの下書き
- 説明資料やプレゼンテーションファイルに変換
○ツール
Visual Studio Code / MarkDown#Editor / Typora / Sublime Text / boostnote / Atom / Brackets / HackMD など
○Webサービス
GitHub / Qiita / connpass / はてなブログ / Dropbox Paper / WordPress など
Markdown記法のメリットと注意点
Markdown記法は、前述のようなシンプルなルールを一度覚えてしまえば、ツールなどの環境が変わっても、同じ方法で記述できます。ファイル形式の拡張子は.mdで、docxやpptx、pdf、htmlなどへの変換ツールも豊富にあるので、効率的にドキュメントを仕上げられます。ただし、ツールやサービスによって、注意点もあります。
○メリット
- 装飾のためのスタイルやタグを気にせずに、簡単に書ける。
- 使えるプラットフォームを選ばず、動作も非常に軽い。
- 構造がわかりやすく、読むのも簡単。
- いろいろなフォーマットで出力するコンバータも充実。
○注意点
- 機能が拡張されていることがあり、書き方のスタイルが若干異なる場合がある。
- スライドショーやPDFなどに変換した場合、表示が微妙に変わることがある。
独自の書き方じゃダメなのか？Officeとの棲み分けは？
ダメなことはありません。得意な領域や機能が違うだけです。自分のためだけなら、どんな書き方でも構いません。ただ、ちょっとした他者と共通のルールに沿って記号を使いながら入力していくだけで、簡単に体裁を整えられたり、見た目を編集できるのは楽です。
Wordは、紙の文化を踏襲したリッチ過ぎる機能が装備されていて、シンプルなドキュメント作成には向いていません。また、プレゼンテーションツールであるPowerPointも、「自由にカオスな印刷物が作れるWord」として利用するべきではありません。この辺りも、目的や特長ごとに賢く使い分けましょう。
職場環境への導入には、いろいろなハードルあり
エンジニアにとってメリットが多いMarkdown記法ですが、チームや職場全体に導入してもメリットがあるかは、また別です。例えば、顧客や取引先とWordやPowerPointファイルをやり取りする場合には、そのままのフォーマットが無難でしょう。また、職場の環境によっては、Markdown記法が使えるような、外部のクラウドサービスや、アプリケーションの利用が制限されていることも珍しくありません。
ただ、アウトプット先がどうあれ、自分の手元でメモしておいたり、一緒に仕事をしているエンジニアグループで使う分には有利だとオススメできます。
身近なところで使ってみよう！
Markdown記法は、全体の基本構造を組み立てながら、そこに肉付けしたり整理していけるので、議事録の速記や、アウトラインプロセッサのような記述と整理には非常に向いています。無駄な時間など1秒もないエンジニアとしては、これを上手く活用しない手はありません。目的をあまり堅苦しく考えず、一度にすべてを覚えなくてもいいので、まずは小規模なチーム内からでも使ってみましょう。
＜PR＞システム運用の効率化のために、プロが使って当たり前なのは、Markdownと統合運用管理サービス。「UOM」はSaaS型だから、現場を満足させる豊富な機能をすぐに使えます。詳しくはこちらへ
