マークダウンを学ぶ：ソフトウェア開発者のためのライティングツール

あなたがソフトウェアエンジニアであるなら、あなたはおそらくあなたの生産性を高めるためにあなたの環境を洗練することに多くの時間を費やしたでしょう。 お気に入りのIDEがあります。 お気に入りのデバッガーがあります。 お気に入りのパフォーマンス監視ツールがあります。 しかし、ドキュメント、マニュアル、およびレポートを作成するためのツールはどうでしょうか。 結局のところ、書くことはあなたの時間の取るに足らない量を要しますね？ 確かに、それはあなたの筆記具について真剣になる時が来ました。

また、あなたは技術的であるため、WYSIWYGエディターが最適なオプションである場合とそうでない場合があります。 メニュー、ツールバー、およびリボンをナビゲートしてテキストをフォーマットする必要はありません（または好きではありません！）。

では、代わりに、すべての書式設定スタイルを単純なインライン構文としてテキストに簡単に追加して、完全に書式設定されたテキストを生成できるとしたらどうでしょうか。

まあ、実際には、あなたはそうすることができます。 それがMarkdownであり、それがこのチュートリアルのすべてです。

多いほど少ないとき…

ワードプロセッシングソフトウェアは、非常に幅広いユーザーとユースケースを満たすように作成されているため、あらゆる種類の機能を提供する必要があります。 しかし、明らかに、その機能のごく一部だけが個々のユーザーに関連している可能性があります。 そして、単にドキュメントを作成したい（そしてマーケティングパンフレットやポスターをデザインする必要がない）ほとんどのユーザーにとって、利用可能な多くのオプションのごく一部が適切です。

実際、Microsoftは、数年前にMicrosoft Wordのユーザーインターフェイスを「リボン」と呼ばれる別個の機能グループに再設計したときに、これを明確に認識しました。 それでも興味深いことに、ほとんどのユーザーは、新しいインターフェースが以前のインターフェースよりも混乱し、ナビゲートするのが難しいと感じたと言うでしょう。

確かに、使いやすさと生産性に関しては、多くの場合、少なくなることがあります。

…そして少ないほど多いとき

それに直面して、あなたはソフトウェアエンジニアであり、グラフィックデザイナーではありません。 そのマニュアル、技術文書、またはレポートを作成して、それで済ませたいだけです。 見出し、箇条書きまたは番号付きリスト、コードブロックなど、いくつかの基本的なフォーマット機能に満足して満足できます。 そして、そうそう、いくつかのフォントフォーマット（太字、斜体など）も役立ちます。 それについてです。 （そして、もしあなたがviでそれをすることができれば、それは本当に素晴らしいでしょう！）

Markdownと入力します。

マークダウンとは何ですか？

John Gruber（技術の第一人者でインターネット活動家のAaron Swartzから多大な貢献を受けた）は、人々が「読みやすく、書きやすいプレーンテキスト形式を使用して、オプションで書くことができるようにすることを目的として、2004年にMarkdown言語を作成しました。構造的に有効なXHTML（またはHTML）に変換してください。」

マークダウンは、タグやフォーマット指示でマークアップされているように見えずに、そのまま読めるように設計されています（RTFやHTMLなどのマークアップ言語でフォーマットされたテキストとは異なり、作成や生のフォーマットでは読みにくい場合があります） ）。

マークダウンを使用すると、読みやすく、書きやすいプレーンテキスト形式を使用して記述でき、構造的に有効なHTMLに変換できます。 したがって、完全に正確に言うと、Markdownは実際には2つのことです。

1. プレーンテキストのフォーマット構文
2. プレーンテキストのフォーマットをHTMLに変換するソフトウェアツール（最初のバージョンはPerlで書かれています）。

Markdownには、いくつかの単純で、かなり直感的で、使いやすい構文規則が組み込まれています。 特にソフトウェアエンジニアとしてのあなたにとって、これらの基本的な構文規則を学び、使用する必要がないので、Markdownは、あなたが書きたいものとそれを書くことの間の抵抗が最も少ない道である可能性があります。

マークダウンを学ぶ：はじめに

マークダウンは簡単に習得できます。 超簡単。 あなたは5分で基本を学ぶことができ、それはすぐに第二の性質になります。 そして、CSSとCSSプリプロセッサの関係と同じように、使用する量は少なくても多くてもかまいません。

あらゆる種類のプレーンテキストの記述規則に慣れている場合は、リストを作成するための文の先頭にある数字やダッシュ、強調するための単語の前後のアスタリスクなど、いくつかのマークダウン規則に既に精通している可能性があります。オン。 したがって、たとえば、イタリックで何かを表示したい場合は、 *this*のようなアスタリスクでラップするだけです（ <span>this</span>のような不格好なHTML構文とは対照的です）。

同様に、行に「＃」プレフィックスを追加するだけでH1見出しを指定できます（たとえば、 <h1>Section Heading</h1>ではなく# Section Heading ）。

特に私たちのソフトウェアエンジニアにとって、Markdownを学ぶためのもう1つの優れた用途は、ソースコードリポジトリのドキュメントにMarkdownを使用することです。 ほとんどのリポジトリにはREADME.mdファイルが含まれています（ .mdはMarkdownファイルの標準拡張子です）。 たとえば、Githubには独自の「Githubフレーバーのマークダウン」があり、開発ドキュメント専用の機能が追加されています。 これにより、このドキュメントをHTMLで作成するよりも確実に時間を節約できます。

簡単な例として、ドキュメントに次のスニペットを含めたいとします。

<h2 style = color：＃3863a0; font-size：1.5em; font-weight：600; margin-top：2em; margin-bottom：1em; line-height：1.3em;>プラグインの開始</ h2>

次のようにjQueryを使用してコンテナでpluginNameを開始します。

$(function() { $('#container').pluginName(); }); コンテナのIDを使用して、jQueryメソッド.pluginName()でpluginNameを開始できます。

これがHTMLとMarkdownでどのように行われるかを比較します。

開始のさらなるヘルプについては、John Gruber（Markdownの作成者）によるMarkdownの概要や、オンラインのMarkdownチュートリアルなど、最新の状態に保つのに役立つ多くのMarkdownチュートリアルがオンラインにあります。

マークダウンパーサーとツール

Markdownで記事を書いたら、構文をHTMLに解析するためのアプリが必要になります。 以下を含む無料の素晴らしいものがいくつかあります：

• StackEdit-GoogleドライブやDropboxなどの人気のあるサービスとの同期オプションがいくつかあるブラウザベースのMarkdownエディタ
• オンラインKramdownエディター-非常にシンプルなインターフェースを備えた別のブラウザーベースのMarkdownエディター
• Mou-開発者にとってよりオタクなオプションとして私が出会った中で最高のMacベースのMarkdownライター。 たくさんの機能と無料（ベータ版中） [これは私がこの記事を書いていたものです]
• MarkdownPad-Windows用の優れたMarkdownエディター
• テキスト-優れたクロスプラットフォーム（MacおよびWindows）エディター。 PDF、.doc、ePubなどの複数の形式にエクスポートします

いくつかの主要なプラットフォームは、それを使用したい人のために、エディターでMarkdownの使用をすでに採用しています（または少なくとも許可しています）。 WordPress、Evernote、Google Docsなどの他の製品では、ネイティブサポート（この記事の執筆時点）はまだ組み込まれていませんが、サードパーティによってカスタムソリューションが導入されています。 これらには以下が含まれます：

• 人気のある新しいブログプラットフォームGhostは、オンラインライティングの合理化を追求し、コンテンツエディターにMarkdownを使用しています。
• WordPressの場合、Jetpackプラグインは正式にMarkdownをサポートするようになりました。これは、プラグインを使用する場合は、 [設定]>[ディスカッション]で有効にできます。 または、WP-Markdownのようなプラグインを使用して、投稿のマークダウンコンテンツをHTMLに変換し、編集する必要があるときにMarkdownに戻すこともできます。
• Evernoteの場合、オンラインエディターのMarkableやMacエディターのBywordなどの一部のMarkdownアプリでは、ノートに直接エクスポートして公開できます。 または、Evernote Webアプリを直接使用する場合は、Markdown Hereというブラウザー拡張機能を使用して、ツールバーボタンをクリックするだけでMarkdownに書き込まれた選択したノートをフォーマットされたテキストに変換できます。
• GoogleドキュメントはまだMarkdownをネイティブにサポートしていませんが、いくつかのエディター（StackEditなど）はドライブと直接エクスポート/同期します。

欠点

もちろん、非常に単純な場合には制限があります。 すでに説明したように、Markdownは、高度なフォーマット機能を必要とする複雑なワードプロセッシングタスク用に作成されたものではありません。 それが必要な場合、Markdownは適切なツールではありません。

しかし、ユーザーマニュアル、技術ドキュメント、またはテクニカルレポートを作成する必要がある開発者にとって、Markdownは、シンプルさと必要な機能のほぼ完璧なバランスを提供します。

おそらく最大の欠点は、特に変更管理がおかしいエンジニアにとって、Markdownで共同作業を行い、変更を追跡できないことです（ただし、これに対する1つの注目すべき例外は、Googleドキュメント用のStackEditプラグインです）。 そしてもちろん、最小限の労力で、gitリポジトリを介してMarkdownドキュメントで共同作業するだけで、通常必要なすべての変更の追跡と共同作業を行うことができます。

結論

では、みんなのためにMarkdownを学んでいますか？ もちろん違います。 誰もツールはありません。

しかし、あなたがソフトウェアエンジニアであれば、それはまさにあなたが探していた筆記具である可能性があります。 したがって、まだ試していない場合は、実際に試してみる必要があります。