DEV Community

e_ntyo
e_ntyo

Posted on • Updated on

Markdownで社内向けドキュメント, 大学のレポート, 本, スライド, ありとあらゆるモノを生成する

はじめに

私のような学生もしくはエンジニアの皆様、普段は如何にして情報のアウトプットをしておりますでしょうか?

所属するチームや組織によって、アウトプットに求められる形式は様々かと思います。私の場合はこうです。

ドキュメントの種類 求められる形式
大学のレポート pdf, docx, TeX, htmlなど、許可された形式
社内向けドキュメント Backlog, Slack, Google Driveで共有するのに便利な形式
発表資料 何らかのスライド形式
社外向けドキュメント Medium, dev.toの対応形式

私の周りの人々を見ると、「レポート等の文書はワードソフトやTeX, プレゼンテーションは専用のソフトウェア,ブログや社内外のナレッジ共有のためのツールでは独自記法, をそれぞれ使っています」という方が一定数いらっしゃいました。

しかしながら、新しいサービスやソフトウェアを使うたびにその記法や使い方を覚えるのは大変ですし、TeXや専用記法は他の人が編集する際にも面倒になる可能性があります😢

基本的にすべてのアウトプットを統一してMarkdownで記述できたら気持ちがええんじゃ、というモチベーションがある方は以下をお読みください。次のようなことが書いてあります。

  • Markdownでpdf/html/docx形式の文書, スライドを生成する方法やおすすめツール
  • Markdownでモノ書きをする上でのtipsや便利ツール

そもそも、なぜMarkdownなのか

  • レンダラによってはemojiがレンダリングされる(超重要)
  • GitHub, Qiita, 各種ブログサービスなど、もの書きやエンジニアが使う多くのWebサービスが対応している
  • TeXなんかと違って人にやさしく(可読性的に)(甲本ヒロト)、他人が編集しやすい
  • html + css相当の綺麗な文書が書ける

Markdown to HOGEHOGE

Markdown to 文書

そもそもMarkdownを書く機会がある方々は、しっかり目のMarkdownを書くとき、どのようなツールをお使いでしょうか?今や多くのエディタがMarkdown向けのlinter, realtime previewなどの機能を実装しているため、手元のエディタで書いている方が多いかもしれません。そうした方もこれまでMarkdownをGitHubくらいでしか使ったことがなかったよという方にも、1度HackMDというWebサービスを試して頂きたいです。

HackMDは数式・多種多様なコードハイライト・UMLなどに対応した、強力なMarkdownエディタを備えたナレッジ蓄積・共有サービスです。書いたMarkdownファイルはGoogle Driveのように閲覧/編集権限を指定して保存することができます。数式, ソースコード, UMLが書けるということはレポートや社内ドキュメントはこれで事足りそうです!

また、書いたMarkdownをHTML/ODFにコンバートしてダウンロードすることが可能です。htmlに変換されると何が嬉しいかというと、CSSを使ってレイアウト等を微調整することができます。これでやたらとレポートの体裁にうるさい教授も黙らせることができます。

いや、まだダメです。一部の教授たちはWordかpdfリーダを使わないと文書が読めない病を患っているため、.pdf .docxに変換する必要があります。この野郎。でも大丈夫です、pandocを使えばコマンド一発でMarkdownをpdf .docx に変換することが出来ます。

pandocの具体的な使い方の説明は他の記事に譲ります(リンク先のdemoページを見ればたいていは事足ります。)pandocを利用してオンラインで.md => .hogehoge をやってくれるWebサービスもいくつかありますが、オプションを設定できないため「数式を殺さないようにしたい」「pdfエンジンを指定したい」といった要望には応えられない場合が多いです。自分も結局手元にpandoc環境を構築しました。

これで、Markdownを自分好みの体裁にしたり、いろいろな文書形式に変換するための道筋がわかりました。

Markdown to スライド

ここまではよくある記事でしたが、ここからは若干有益な情報が含まれていますよ!
Markdownでいわゆる発表用スライドを生成できるサービスを2つご紹介します。

1. SlideShip

SlideShipは、オンラインでMarkdownを書いてスライドを作成・公開・利用するWebサービスです。
何度か発表に使ってみたので所感を書いておくと、

よかったところ
  • LTなどの簡単な発表資料を爆速で作ることができる
  • 豊富なカラーテーマが用意されている
  • スライドをpdfにコンバートしてダウンロード可能
よくなかったところ
  • 微妙に機能が足りない
  • スタイルの細かい調整ができない
  • emojiがレンダリングされない

2. HackMD

HackMDは神なので、独自の記法(といっても大層なものではなく、ごく簡単なものです)でMarkdownを書くと、なんと!HTMLのスライドが出来てしまいます。

これこういう感じになります。

よかったところ
  • 上の通り、HackMDで普段レンダリングされているものがそのままスライドになる(神!!!)
  • reveal.js でHTML(CSS, JS)が生成されるため、凝りたいなら自分でいじって調整できる
    • SlideShipよりも素の出来がいいためいじらなくてもいい感じになる
よくなかったところ
  • まだbetaで、いろいろ挙動が怪しい

Markdown to 本

HackMDは本当に神なので、スライドと同じノリで本も吐き出されます。自分はまだ実践していないのですが、こういう感じになるようです。素晴らしい…

まとめ

もう西暦2018年なので、基本的に普段のメモをMarkdownで書いておけばアウトプットはたいていなんとかなります。HackMDは神。ありがとう。

Markdownあるある(はやく言いたい)

Tableがつらい

オンラインのジェネレータがあります。

HackMDはUMLが書けるけれど、その他の図が書けないし、やっぱりPowePointがいい

マイクロソフトに魂を売るのか?黙れ。 オンラインでいろいろな図を作成するならdraw.io が便利です!

Discussion (0)