pandocを使いたい理由
pandocは、マークダウンテキストからHTMLやWordなど各種形式に変換してくれる便利なツールと聞き、使ってみたことを記録。
pandocを使うメリットとしては、バージョン管理しやすいというのが大きな点ですかね。
あとはお客様への納品形式がWordかHTMLかまだ不確定とか、色々な理由があるみたいですね。
今回は、システムの操作マニュアルを作成するためにWordファイルを取得したい。小さいシステムなので、それほど大がかりなものではないけども。後学のために触ってみました。
書式はある程度決まっていたので、テンプレートを利用してファイル作成することを試みます。
pandocの使い方
pandocインストール
https://github.com/jgm/pandoc/releases/tag/2.9.2
自分のPCはWindows 64bitなので、pandoc-X.X.X-windows-x86_64.msi をダウンロード、順次クリックしていくだけでインストール完了。簡単ですね～
コマンドプロンプトから確認。
pandoc -vバージョン情報が表示されればOK。
MDファイル作成
VSCodeでリアルタイムに確認しながら作成できます。（ひどい画像・・笑）
実はマークダウンてあまり書いたことないし、VSCodeも全然使いこなせてない。課題、課題。
今日は以下を学びました。
- 見出し
- テーブル
- イメージ
おそらくマニュアル作るにあたっては、この辺りからでいけるかな。
【2020/02/25 追記】
以下のように記述すると、表題等のスタイルが適用されます。
---
title: タイトルです
subtitle: サブタイトルです
author: 著者です
date: 2020/02/25
---Wordテンプレートファイル作成
新たにワードを開き、見出しなどのスタイルを設定し、.dotx の形式で保存。（.dotxという拡張子があることを今日知りました。。）
ワードは普段使わないから苦手意識すごいなあ。
こちらなど参考にさせていただきました。
マークダウンで書く表（テーブル）にあたるもののスタイルって設定できる？（こちらも調査中）
【2020/02/05 追記】
必ずしもdotx 形式にする必要はなく、docx 形式で問題ありませんでした。
以下を実行することで、カレントディレクトリにテンプレートファイルを作成できます。
pandoc --print-default-data-file reference.docx > reference.docxpandoc実行
mdファイルがあるフォルダに移動して、以下を実行。
pandoc （マークダウンテキストファイル名）.md --reference-doc=
（テンプレートファイルのフルパス）.dotx -o （出力するファイル名を指定）.docx目次を付けたいときはオプションを指定。これはマニュアル作成には使えそう。
--tocmdファイルと同一フォルダにワードファイルが作成されます！
今後の課題
現在調査中のものが多いですね＾＾；
VSCodeの使い方とマークダウン記法は使いこなせるようにしたいところ。
調査中のものは分かったことがあったら随時更新していきます。
コメント