HackMDを使ってweb上でmarkdownファイルを編集・管理する


はじめに

日頃,研究やアプリ開発をする際に,新たに発見したことや苦労した部分などをメモとして残すことがあります.その際に,markdownファイルとして残すことが多いのですが,ローカルのストレージに保存しておくのではなく,Web上に残したいと考えました.以下の理由があります.

  • ローカルのストレージを使用しすぎると,パソコンの動作が重くなる
  • 数台のパソコンを使用している場合,ローカルにファイルを残すと別のパソコンで使えない
  • GoogleDriveなどを使用する場合,保存容量の上限がある

これらの理由から,markdownファイルはWeb上で管理することにしました.Qiitaで管理してもよいですが,メモを共有したくない場合があると思います.色々調べた結果,HackMDというWebアプリを使用することにしました.

HackMD

HackMDは,Web上でmarkdownを記述できるエディタであり,保存もしておけるWebアプリです.HackMDを選んだ理由として,以下の利点があります.

  • 無料かつ簡単に登録することができる.
  • リアルタイムプレビューができる
  • Qiitaを使用している感覚で使用できる
  • sublimetext, emacs, vimモードがデフォルトで使える
  • 公開範囲,編集可能な範囲の設定ができるため,プライベートにもパブリックにも使える
  • 自分で作成した記事に対してtag検索ができるため,ファイルにtagをつけることで記事をジャンル別に管理し,目的の記事を簡単に見つけられる
  • URLを作成し,他人に共有することで,簡単に記事を共有できる

HackMDの使い方

インストール~便利な機能まで紹介します.

インストール

HackMDのホームページ新規登録ボタンから登録をします.

ログイン後

登録してログインが完了したら,メモを作成ボタンを押すことで,markdownファイルが作成され,編集画面が表示されます.編集画面では,はじめに以下の設定をする必要があります.

  • 右上の共有マークを選択し,編集可能,閲覧可能者の制限を設定する
  • 画面下でEditorのモードを設定できる (emacs, vim, sublimetext)
  • 画面下でスペース幅や背景の色なども変更できる

記事にタイトルとタグをつけるには,markdownファイルの先頭に以下のように記述します.タグは複数記述することが可能です.

---
title: PythonでのHello World
tags: Python, Ubuntu
---

また,記事に画像を挿入するには,ローカルにある画像をコードにドラッグアンドドロップすることで挿入できます.その他は普通のmarkdown記述と何ら変わりません.

記事の検索

ログイン後の画面から,tagを用いて記事を絞り込むことができます.検索窓にtagを入力すると,記事にtagが設定されていればヒットします.複数tagを用いたAND検索などもできます.他にも,ファイルを更新順に並べたりして目的の記事を探すこともできます.

終わりに

今回紹介したHackMDにより,markdownのメモをWeb上で管理し,管理している中で探したい記事を簡単に検索することができるようになりました.markdownで記述したファイルの管理をWeb上で行いたい,編集も同時に行いたいという方がいましたら試してみてください.