Markdown記法でメモをとって管理し、ついでに資料も作成

仕事をしている最中にメモをとることが多々あるでしょう。
PCでメモを取る際、簡単な物であればWindows10標準の「付箋」を使い、長い物をメモするのであれば、標準のメモ帳を使うと思います。
しかし、標準のメモ帳では管理が難しくどこに保存したか忘れることがあるでしょう。
それをMarkdown記法でメモを取ることによって、管理や資料の作成をしたいと思います。

Markdown記法とは

簡潔に説明するとMarkup言語であるHTMLを簡略化したものである。
様々なツールを使ったことがある方は、Markdown記法を見たことがあると思います。(自分が見たことあるのはBacklogです。)
例を挙げると下のようになる。

HTMLでの書き方↓

<h1>見出し</h1>
<blockquote>引用</blockquote>

Markdownでの書き方↓

# 見出し
> 引用

使用するエディタ

使用するエディタはなんでもいいと思います。
Markdown用等ありますが、普段使用しているエディタで使えるのでそれでよいでしょう。
特にない場合はVisual Stuido Codeを使用しましょう。(拡張機能をインストールする必要がありますが、コーディングするには軽いのでおすすめのエディタです。使用している方が多いので使い方の検索がしやすいです。)

メモをとってみる

まずは保存先を作りましょう。(ネットワークでも可)
エディタで新規ファイルを作成し、拡張子.mdで先程作った保存先に保存します。
これで標準のメモ帳と同じことができるようになりました。

管理をしてみる

現時点では、標準のメモ帳と同じで管理が難しい状態ですので、vscodeの拡張機能VSNotesを使用して管理しやすくしてみたいと思います。
vscodeの左側のタブにマークが表示されていつでも開けるようになる。

1.VSNotesをインストール
vscodeで拡張機能のタブをクリックして開く。(ctrl+shift+xでも開ける)
検索タブでVSNotesと検索する。(大文字小文字関係なし)
インストールする。

2.初期設定
コマンドパレットを開く。(ctrl+shift+p)
VSNotesと入力し、VSNotes: Run setupをクリックし、右下に出た警告のStartをクリックする。
フォルダーの選択画面がでるので保存する場所を決めます。(ネットワークでも可)
決めたらvscodeを再起動して完了です。

3.タグ管理
タグ機能があり、タグ分けを行うことで管理がしやすくなる。
メモの上の方に以下のようなタグを入力するとタグ分けが行える。

---
tags:
- vue.js
---

※VSNotesで新規メモ作成
コマンドパレットを開く。(ctrl+shift+p)
VSNotesと入力し、VSNotes: Create a New Noteをクリックする。
入力欄にタイトルを入力して、Enterで作成する。(Escでキャンセルできる。)
※この機能の方が日付を自動でつけてくれるのでこれを使用した方が良い。

資料を作ってみる

.md形式単体では資料をつくることはできません、なのでツールを使用して資料を作成していきたいと思います。
色々とあるみたいですが、Marpがいいと思います。理由として使いやすいのとvscodeにMarp for VS Codeという拡張機能がある所です。(npm等、コマンドに触れなくて良い。)
※会社のセキュリティ問題で書き出しがうまくいかない場合がある。

1.Marp for VS Codeをインストール
vscodeで拡張機能のタブをクリックして開く。(ctrl+shift+xでも開ける)
検索タブでMarp for VS Codeと検索する。(大文字小文字関係なし)
インストールする。

2.初期設定
資料にするメモ(.md形式)を開き、メモの上に以下のコードを入力する。

---
marp: true
---

タグ管理しているときは下のように書く

---
marp: true
tags:
 - vue.js
---

3.入力
ページ分けや見出し設定をしましょう。(よく使うものだけ簡潔に、他にもあります。)
※記号の後に半角スペース必須です。
---(ページ分け)
#(見出しレベル-最大6個)
-(箇条書き)
**(太字-※囲む)

4.プレビュー
右上にあるエディターを分割するボタンの近くにプレビューボタンが追加されてるのでそれをクリックする。
(2.初期設定のコードがうまく反映されていればプレゼン資料みたいになっているはずです。)

5.出力
先程のプレビューボタンの横にあるMarpアイコンをクリックする。
Export slide deck… をクリックする。
フォルダーの選択画面がでるので、ファイル形式と名前を決めて保存する。

終わり

以上のことがわかれば、メモを取りつつ簡単な資料が作成でき管理まですることができると思います。
Marpにはまだ細かい設定があるので気が向けば他のnoteにまとめたいと思います。

この記事が気に入ったらサポートをしてみませんか?