背景
ブログ・技術ドキュメントなどの多種多様なドキュメントを Markdown 記法を用いて作成している(論文は Tex を使っているが...).私はテキストエディタとして Emacs を使っているため,markdown-mode
を活用して文章を執筆している.
本稿では,高速にドキュメントを作成するために使っている機能をまとめる.なお,インストール手順は検索すればたくさん出てくるため割愛する.
ショートカットキー
定形の構文はショートカットキーを活用して,入力ミスと入力時間を削減する.普段使うもののみを表にまとめる.
ショートカット | 説明 |
---|---|
C-c C-n | 次の見出しに移動 |
C-c C-p | 前の見出しに移動 |
C-c C-s b | 太文字 |
C-c C-s c | コードブロック |
C-c C-d | ToDoの挿入 |
C-c C-l | Linkの挿入 |
C-c C-s t | 表の挿入 |
C-c <S-right> | 列の挿入 |
C-c <S-left> | 列の削除 |
C-c <S-down> | 行の挿入 |
C-c C-c v | プレビュー |
全てのショートカットキーはこちらにまとめられている.
markdownlint
キレイな Markdown-file を作成するため,markdownlint で構文チェックを行う.こちらはコンテナがあるため,そちらを利用.
docker run -i --rm tmknom/markdownlint -s < README.md
markdown to pdf
markdown を見栄えのよい PDF にして出力する.出力方法は2種類あり,未だにどちらかに統一できていない.
# markdown-pdf docker run -v $PWD:/opt/docs pistatium/markdown-pdf:9.0.0 markdown-pdf -o README.pdf README.md # pandoc pandoc README.md -o README.pdf -V documentclass=ltjarticle --pdf-engine=lualatex
まとめ
本稿では,Emacs x Markdown を題材として,markdown-mode
及び Markdown に関連するツールによる高速ドキュメント作成を示した.作業削減や自動化などのアップデートを今後行う予定.