12. Markdown

Markdownマークダウン は軽量マークアップ言語であり、多くのプロの技術者によって技術文書の作成・編集に使われています。Markdown を使えば vi や Emacs といったプレーンテキストエディタで文書を執筆でき、そのときヘッダー・太字・箇条書きといった要素を作成するための特殊記法が利用できます。Markdown でフォーマットされた簡単な技術文書の例を次に示します:

## bash and ksh

**bash** closely resembles an older shell named **ksh**.  The key
*practical* difference between the two shells is as follows:

*  More people know bash than ksh, so it is easier to get help for bash
   problems than ksh problems.

このテキストをレンダリングすると次のようになります:

bash and ksh

bash closely resembles an older shell named ksh. The key practical difference between the two shells is as follows:

  • More people know bash than ksh, so it is easier to get help for bash problems than ksh problems.

Markdown パーサーが Markdown ファイルを HTML に変換し、ブラウザがその HTML を読者に表示します。

次のチュートリアルを使って Markdown に慣れておくことを推奨します:

この次は?

おめでとうございます! あなたは『テクニカルライティング One』の pre-class 部を完了しました。

あなたの機関で『テクニカルライティング One』の in-class 部が利用可能なら、ぜひ受講してください。あなたが in-class 部を主催するのであれば、facilitator's guide を参照してください。

『テクニカルライティング One』で触れたトピックを 13. まとめ ページに簡単にまとめてあります。

広告