HANDAI JK Engineering Blog

HANDAI JKの技術ブログです

Markdownを使ってレポート課題をサッサと終わらせよう

HANDAI JKの石田です。

大学の研究室に新しいメンバーが入ってきて、新しい気分で新年度を迎えられそうです。 さて、今回はMarkdownの話をしたいと思います。

Markdownとは

Markdown(マークダウン)を使うと、簡単かつ高速にいい感じに文書を作成することができます。 聞くより実際に触った方が分かりやすいと思うので、StackEditMarkdownを体験してみましょう!

stackedit.io

Markdownの記法

Markdownで見出しを作るには頭に「#」をつけます。

# ミダシ1
## ミダシ2
### ミダシ3

「#」の数を増やすとさらに小さな見出しになります。

また、箇条書きにするには頭に「*」をつけます。

* アイテム1
* アイテム2
  * アイテム2-1
  * アイテム2-2

StackEditで試してみるとこんな感じで表示されると思います。簡単ですね!

f:id:handaijk:20190415173313p:plain
StackEditの画面 (左が入力、右がプレビュー)

Markdownは何に使われているか

MarkdownOSSプロジェクト等のREADMEと呼ばれる、ソフトウェアの添付文書のフォーマットとして広く使われています。

f:id:handaijk:20190415173633p:plain
GitHubに公開されているREADMEの例 (facebookresearch/Detectron)

また、Pandoc - About pandocというものを使うことでMarkdownをPDFにも変換できるのでちょっとしたレポートを作成する時にも便利です。僕はたまに大学のレポートをMarkdownで書いていました!

And more

Markdownには見出しや箇条書きのほかに太字にしたり、斜体にしたり、リンクを貼ったり、画像を入れたり、引用をしたりできます。記法はググって調べてみてください。すぐに慣れて使いこなせるようになるはずです!