ドキュメントは Markdown で書こう
Markdown 記法書きやすいですよね。昔ははてな記法とか使ってブログを書いていた時期もあるんですが、Githubがこれだけ普及した今、Markdown記法が世界的なグローバルスタンダードになっています。私が使っている WordPress でもプラグインを入れれば簡単に Markdown で書けるにようになるし、他のQiitaなどのブログでも普及が進んでいます。先述したように、Githubなどのプログラムのドキュメントを書く際には、 よほどのことがない限り Markdown が選ばれています。
Markdown はどうやって書くの?
これは今回の記事の趣旨とは外れるので、チートシートあたりを見れば大体コツをつかめると思うのでリンクを紹介しておきます。
![](https://qiita-user-contents.imgix.net/https%3A%2F%2Fcdn.qiita.com%2Fassets%2Fpublic%2Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png?ixlib=rb-4.0.0&w=1200&mark64=aHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9UWlpdGElMjAlRTMlODMlOUUlRTMlODMlQkMlRTMlODIlQUYlRTMlODMlODAlRTMlODIlQTYlRTMlODMlQjMlRTglQTglOTglRTYlQjMlOTUlMjAlRTQlQjglODAlRTglQTYlQTclRTglQTElQTglRTMlODMlQkIlRTMlODMlODElRTMlODMlQkMlRTMlODMlODglRTMlODIlQjclRTMlODMlQkMlRTMlODMlODgmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZ0eHQtY2xpcD1lbGxpcHNpcyZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPWJkNGVhYmYzNmQ5ZTVhNTNkOGE4OGQ3YjA3NTUyOWY3&mark-x=142&mark-y=112&blend64=aHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTcxNiZ0eHQ9JTQwa2Ftb3JpdHMlMjBpbiUyMCVFMyU4MyVBQSVFMyU4MiVCMyVFMyU4MyVCQ0lUJUUzJTgyJUJEJUUzJTgzJUFBJUUzJTgzJUE1JUUzJTgzJUJDJUUzJTgyJUI3JUUzJTgzJUE3JUUzJTgzJUIzJUUzJTgyJUJBJUU2JUEwJUFBJUU1JUJDJThGJUU0JUJDJTlBJUU3JUE0JUJFJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzImdHh0LWFsaWduPWxlZnQlMkN0b3Amcz0xMTUzMjM1MWUwNWI3ZjNjNDkyODBkNDk4MTMzNTk4Ng&blend-x=142&blend-y=491&blend-mode=normal&s=e6f927ca5d42fdfc5281d461d814c2a9)
Markdown Editor はどれを使うか
これについては結構調べていまして、おすすめのものをいくつか紹介しておきます。
Boostnote
![](https://fx-kirin.com/wp-content/uploads/cocoon-resources/blog-card-cache/4c033e2d3419be871900c8726980c41a.png)
私が使っている Markdown Editor です。これを使っている理由はデスクトップアプリであることと、Markdown テキストと実際の描画がシンクロして表示してくれる点です。他にも Dropbox と連携して少し設定すればパソコンで書いているものに、携帯から書き込みができるようになったり、Wordpress への投稿ができたりします。何より、個人的には Vim mode がかなり優秀だからということが大きいです。Vim mode については、また後日記事にします。
MarkText
次におすすめしたいのが、Marktext です。これは、同じようにデスクトップアプリであり、リッチな方法で記入をしていけます。Markdown 記法で入力をすれば、そのとおりに現在の表示を切り替えてくれます。なので、Markdown テキストを書くと言うよりは、実際のビューを作っていくことになります。もちろん、Markdown 表記での直接の編集もできるようになっています。
このアプリの一番優秀な点は、テーブルの編集がとても楽にできる点です。Markdown テキストでも、縦横の線の整形を Marktext 側で行ってくれるため、他のエディタを使っていてもテーブルの作成と編集だけはこのアプリを使うということをしています。
HackMD
![](https://fx-kirin.com/wp-content/uploads/cocoon-resources/blog-card-cache/852baa327d46417b23884176e587d91e.jpg)
これは、ウェブベースの Markdown Editor です。他人と共有できるのが他にはない一番の利点。共同で同一のドキュメントを編集するなんてこともできます。ただ、アカウントとドキュメントが紐付いてしか作成できないため、他の人とドキュメントを共有して管理するということには向かないというのが期待はずれでした。
Typora
これもデスクトップ環境のエディタです。Qiita とかでよく紹介されているようで、人気があるみたいです。かなり Marktext と似ている気がしていて、Typora はオープンソースじゃないみたいだし、どうせ使うなら Marktext のがいいんじゃないでしょうか。
Quiver
Mac の人はこれ使っている人結構みかけます。
あとがき
先述したように、私は Boostnote 使いなので、Boostnote びいきなのは否めませんが、Marktext は一度触ってみる価値があります。HackMD も人と一緒に編集するような用途によってはとても使いやすいです。あとの2つは人気のものを紹介しておきました。
コメント