ドキュメント作成・管理について考える(Visual Studio Code * Pandoc)

Visual Studio Code(以下vscodeと記述) * pandoc が良さげ





やりたいこと



  • バージョン管理をしたい
  • 差分を見たい。そのためにシンプルな形式を保ちたい
  • 先方に見せやすい形式で出力したい(word, html)
  • 上記を統合的でシンプルな手順で実現したい




Visual StudioとPandocで何ができるか



Visual Studio Code でできること

https://www.microsoft.com/ja-jp/dev/products/code-vs.aspx

  • gitを使用できる
  • マークダウンファイル(.md)のをハイライト表示、プレビュー表示ができる。
  • 表示 → 統合ターミナル からWindowsならコマンドプロンプト、Macならターミナルを起動してコマンドを実行できる。


Pandoc でできること

http://pandoc.org/

  • mdファイルからword,pdf その他多様なファイルを出力できる
  • テンプレートを指定してスタイルを指定できる
  • コマンドを使用して出力する。つまりVisual Studio Code上から実行できる

ちなみにvscodeもpandocもOSを問わず使用可能です。




具体的な手順



Macでの手順ですが他環境でもそれほど変わりません。

vscodeとpandocをインストール


VisualStudioCodeダウンロード & インストール
https://code.visualstudio.com/download

参考
http://qiita.com/74th/items/12521790a1c680af934c

Pandocダウンロード & インストール
ttps://github.com/jgm/pandoc/releases

参考
https://nacl-ltd.github.io/2016/03/10/easy-documentation.html

mdファイル(マークダウンファイル)の作成・プレビュー・バージョン管理

vscodeを立ち上げてgit管理されているディレクトリを開きます。
mdファイルを作成します。
Shift + /(Macの場合)で画面の分割、Shift + command + V でプレビューを表示することができます。
Ctrl + Shift + G でGit画面を表示してバージョン管理します。
以上でmdファイルのバージョン管理ができるようになります。

wordファイルのスタイルテンプレートを作成

スタイル指定用のtemplate.docxを作成します。
区切りごとに改ページを入れて見ます。


Wordでのスタイル変更方法
テンプレートにするファイルを開く
スタイルから見出し1を右クリック(事前にスタイルの変更が必要?) → 変更
→ 書式 → 段落 → 改ページと改行タブ → 段落前で改ページするにチェック
バージョンによって違うかも

Libre Office Writerでのスタイル変更
Heading1 項目で右クリック → Edit Style...
Text Flow タブをクリックして
BreaksのInsertにチェック(Type:Page Position:Before)

mdファイルの # [text]

docxファイルのスタイル Heading1が紐つく形になっている。
詳細は公式参照のこと

vscode上からPandocを使用してdocxファイルを作成する。
現在表示中のディレクトリ直下に以下の2つのファイルがあると想定します。
readme.md (マークダウンで記述されたドキュメント)
reference.docs (テンプレートスタイル用のファイル)

表示 → 統合ターミナル (Ctrl + Shift + @)
pandoc -f markdown --toc readme.md -t docx -o sample.docx --reference-docx=reference.docx
同階層にsample.docxが作成されます。



あとはお好みで


2017年1月17日火曜日