初めに
本記事はMarkdown便利だから使って慣れようとお勧めする記事であり、Markdownの文法について学ぶ記事ではありません、あしからず。
経緯
社内で自己学習の内容についてQiitaの投稿が可能になったが、そもそもチーム内でMarkdownを使える人があまりいなかった。まあ自分も一年前にGithubやQiitaに触れてからMarkdown使いだしたので、そこはこれから学べばいい話。
とはいえ、いくらMarkdownが簡単だからと言って、Qiitaのために仕方なく学ぶというのはモチベーションも上がらないし、せっかく便利なのにそれではもったいない。1
ということで、自分の経験を踏まえ、Markdownってこんなに手軽かつ便利につかえるから使いながら覚えてこうという話。
対象の読者
- Markdownよく知らない人
- QiitaのためにMarkdown覚えるの面倒という人
- エンジニアじゃないからMarkdownなんて必要ないと思っている人（そんな人がどうやってこの記事にたどり着くのかという問題はあるが…）
すでにMarkdownを学ぶ気がある人はMarkdown記法 チートシート - Qiitaでどうぞ
Markdown の概要
Markdownとは、プレーンテキストのように簡単に読み書きでき、htmlに変換ができる(=htmlのように文書の構造化ができる)記述法である。
詳しくはWikipedia
ここ、Qiitaの記事のように、Markdownで書かれた原文をhtml化して体裁を整える（以降レンダリングとする2）という使われ方が一般的だと思う。3
具体例1: レシピ
といってもぱっとはわかりづらいとおもうので、さっそく具体例を挙げてみる。
とっつきやすいよう、技術的ではない例として、適当にレシピでも書いてみる
### カレーっぽいレシピ
通常は`#`が見出し1=タイトル、`##`が見出し2、 `###`が見出し3と階層化していくのだが、
今回はQiitaの本文に埋め込んでも階層が壊れないよう`###`から始めている
#### 材料
- スパイス
- コリアンダー
- ターメリック
- クミン
- ニンジン
- 牛肉
- etc
#### 手順
1. 切る
2. 炒める
3. 煮る
#### 備考
玉ねぎはちゃんとあめ色になるまで炒める
これがQiitaの本文中では以下のように表示される
カレーっぽいレシピ
通常は#が見出し1=タイトル、##が見出し2、 ###が見出し3と階層化していくのだが、
今回はQiitaの本文に埋め込んでも階層が壊れないよう###から始めている
材料
- スパイス
- コリアンダー
- ターメリック
- クミン
- ニンジン
- 牛肉
- etc
手順
- 切る
- 炒める
- 煮る
備考
玉ねぎはちゃんとあめ色になるまで炒める
こんな感じ。
要点
ここで強調しておきたいのは以下の3点
- Htmlのようにテキストに見出し1、見出し2、リスト、強調などの意味を持たせられる
- Htmlと違い、ブラウザを通さない、ソースの状態でも読み書きしやすい
- ただのテキストファイルとして扱えるので、軽く、環境を選ばない4
GithubやQiitaで使われていると聞くとエンジニア向けの印象が強いが、実のところ軽く読み書きしやすいことから、ちょっとしたメモにとても重宝する。
そのほかに、意識してMarkdownの構文をつかうことで、結果的に文の構造を意識するようになるのもメリットだろうか
本来であればそういうのは国語の授業で学んでおけといわれてしまえばそれまでだろうが…。5
具体例2: 日々の予定
チェックリストも作れるので、ToDoリストも書ける。
### 2020/07/08
#### やること
- [ ] 作業報告
- [x] Qiitaの投稿
- [ ] ごみ出し
#### 備考
朝のごみ出し忘れてしまった
2020/07/08
やること
- 作業報告
- Qiitaの投稿
- ごみ出し
備考
朝のごみ出し忘れてしまった
このようなちょっとしたメモ書き程度ならレンダリングなしでも十分使える。 3
結論
適当なテキストエディタとMarkdownだけでも日々のメモ書き程度なら問題なくこなせるので、ガンガン使って慣れよう
余談1: IME
#や-など、行頭に着ける記号とスペースは半角である必要があるのが日本人的にはやや不便。
IMEでデフォルトで記号が半角になるようにしておくと楽。
あと半角スペースはシフト+全角スペースでも入力できるので、これも覚えておくと楽
余談2: Markdownが使え、かつクラウドなメモアプリ
スマホやクラウドな時代にPCのテキストエディタでローカルでメモを書くのはどうなのか。
ということでMarkdownでメモれるクラウドサービスを昨年探していて、いくつか実際に試していたのでついでに紹介してみる。
実際に調べて試してたのは2019年なのですでに情報が古い可能性があるのでそこは注意
Simplenote(おすすめ)
メモ特化のアプリ。聞きなれない名前だが、開発、管理しているのはWordpressと同じところなので、信頼性については問題ないかと思う、
良かったこと
- マルチプラットフォームでOSを問わず使える
- 軽い
- オフラインでも読み書きが可能
欠点
- 画像が扱えない
- オフラインで作成（更新）されたメモが一度同期に失敗した後、次いつ同期されるのかが不明。少なくともオンラインに戻ってすぐには同期されなかった。
Dropbox Paper
Dropbox のメモサービス
ファイルの保存先もDropboxの中になる。
保存形式が独自形式だが、Markdownの描き方で書式が設定できる
具体的には、#を入力した時点で編集中の段落が見出しになるといった感じ。
メリット
- Dropbox を使っている人であれば、アカウントを増やさなくても使える
- スマホ版ならアプリがあるのでオフラインでも編集できる
デメリット
- IMEとの相性が悪いのか、(自分が使っていた当時は)日本語入力だとMarkdown形式の記号を入力しても書式が反映されないことがあった。
- PC用のアプリがなく、ファイル形式がなぜか独自仕様のため、オフラインでは使えない。
Nextcloud
平たく言うとDropboxのオープンソース版といったようなアプリ。機能の一つとしてMarkdown対応したメモアプリを追加することで、ブラウザからMarkdownやテキストファイルを編集できる
メリット
- PC版のNextcroudであればDropboxのようにファイルをローカルに保存するうえ、Dropbox Paperと違いちゃんとプレーンテキストなため、オフラインでもローカルのテキストエディタで編集できる。
- 自分で運用する分プライバシーの面ではDropboxやGoogleクライドのようなほかのクラウドストレージサービスよりも安心感があるかもしれない。
デメリット
- Nextcloudを使うのにそもそも自分でサーバー借りてインストール、運用する必要があり、登録するだけの上記二つと比べハードルがかなり高い。
- スマホ版のアプリでもメモの編集ができない（スマホにインストールされている別のテキストエディタで編集できる可能性はあるが、未検証）
-
個人的にはもっと早く知りたかったと思うくらい重宝している。今日日PCもスマホも持ってない人はまれだろうし、その点で言えばだれもが使えるし、何だったら義務教育でおしえてくれてとすら思っている。 ↩
-
htmlに限らず、パワーポイントとかにもできるらしい。 ↩
-
画像を挿入する場合は別、レンダリングしないと見れない。表もソースのまま読める形にするには列幅ををスペースで調節する必要があるのでかなり面倒） ↩
-
Markdownで書かれたファイルは
.mdというMarkdownファイル用の拡張子にするが、中身はプレーンテキストと変わらず、メモ帳でも開ける ↩ -
思えば学生時代は黒板書き写すので精一杯というか、それすらできてなかったので、見出しで階層化するとか基本的な文章の構造すら考えもしなかった。 ↩