CCWO Embedded Space

CCWOの日々の開発を発信するブログ

Markdown の ススメ

Markdown VSCode

ここのところ

Markdown

の資料をよく見かけ、私も最近よく利用しているのでまとめてみたいと思います。

まずMarkdownをどのようなところで利用しているかというと

  • メモ
  • リマインド
  • 資料製作
  • 発表資料製作

に用いています。主に, Visual Studio Codeと連携して使っています。

Markdown形式の特徴としては、自分自身の思考を文書としてキレイに早く整理できることにあると思います。

textで書くには不十分すぎる、しかしpowerpointやwordにまとめるには大げさすぎる・・・もっと手軽に文書をキレイに整理したいというときにその真価を発揮するかと思います。

そこで、まずMarkdownがよくわからない方むけにどのようにMarkdownにて資料を作成しているかを説明します。

1. Visual Studio CodeでMarkdownファイルの作成

Visual Studio Codeにて拡張子を .md として新規ファイルを作成します。
(Ctr+N→Ctr+S→hogehoge.mdで保存)

2. Markdownのプレビュー

Markdownの作成時は.mdファイルを編集しながら隣で出力結果をプレビューすると現在の状態がわかりやすく便利です。

f:id:CCWO:20180816180508j:plain

このように左に編集画面、右にプレビュー画面とすることができます。
方法は、

  1. Ctrl + Shift + P にてコマンドパレットを表示
  2. Markdown Open Preview to the Sideと入力

でプレビューをすることができます。（VSCodeではコマンドの使用はショートカットキーを使うことが効率的なため今後もこの説明とします。）

3. PDF等に出力

Markdownが編集し終わりましたら、PDF等に出力します。
(VSCodeの拡張機能にてMarkdown PDFをインストールしておいてください。)
marketplace.visualstudio.com

f:id:CCWO:20180816180751j:plain

方法は

  1. Ctrl + Shift + P
  2. Markdown PDF: Export (pdf)と入力

これで作成したMarkdownの資料をpdfとして出力することができます。

4.チートシートの作成

注：ここからは参考程度です。

はじめのうちはMarkdownでの記法に慣れず検索することが多くなると思います。そこで、チートシートと呼ばれる自分だけのテンプレートを作成しておくと作業効率があがり便利です。
こういったものです。
qiita.com
qiita.com

私の場合はこれをtemplate.mdとしてもっています。少し長いので下に載せました。

このようによく使うものを列挙しておいて忘れたときにコピペするか、思い出すために利用します。
このチートシートでは、

  • 見出し
  • リスト
  • 番号付きリスト
  • ソースの貼り付け
  • 表
  • リンク
  • チェックボックス

を並べてあります。

このようにして私はMarkdownにて資料を作成しております。Markdownのいいところは手軽に体裁のよい資料をpdfとして保存するまでの一連の流れをとても高速に行うことができることです。そして、Markdownはその資料の書き方の都合上、文書がツリーの構造になりやすいです。そのため、さまざまな軸（ツリーの構造）を考えながら、頭の中を整理することに向いています。私は本の要約・セミナーのまとめ・リマインダー・メモとして活用しております。また、最近ではよくMarkdownを用いながら会議を行うという風景を目にすることが多くあります。Markdownは手軽に頭の中を整理し出力するというメリットを活かして、会議中にこれをスクリーンに表示し、お互いに意見を述べ合いながらこちらの意見を理解してもらいやすくなります。また、相手の意見を促し修正するという作業を通して会議を進めていくことができ、本来の会議の目的である議論の成熟を促すことができるかと思います。（近年トヨタなどでは、合議を得るために作成されるpowerpoint資料を禁止するなど、会議をより活発に行うことに重きが置かれておりその意味でもMarkdownは有用であるかなと考えています。）

最後に、Markdownは日々使おうと思えばすぐに定着していくかと思いますので、ぜひ使ってみてください。
（今回の記事はかなり体裁を気にしてよみやすいように工夫してみました。）

# H1

## H2

---

### H3

---

#### h4

---

## List

- list 1
  - list 1-1
    - list 1-1-1
      - list 1-1-1-1
      - list 1-1-1-2
  - list 1-2
    - list 1-2-1
      - list 1-2-1-1
  - list 1-3
- list 2
- list 3
- list 4

## Number List

1. list 1
    1. list 1-1
        1. list 1-1-1
            1. list 1-1-1-1
            1. list 1-1-1-2
    1. list 1-2
        1. lisit 1-2-1
            1. list 1-2-1-1
    1. list 1-3
1. list 2
1. list 3
1. list 4

## Source Code

```
program
```

## Table

| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This | This | This |
| column | column | column |
| will | will | will |
| be | be | be |
| left | right | center |
| aligned | aligned | aligned |

## Link

[Title]()

## Check Box

[ ] check 1
[ ] check 2
[ ] check 3

2018/08/16の記事