Post on 22-Jul-2015
webのドキュメント管理何使ってますか?
• Sphinx
• wiki( *wiki , GitHub , Backlog , etc..)
• CMS(wordpressなど)
ドキュメントの記法は同じですか?
Markdown方言問題• エディタやコンバータで文法が細かく異なる
o 標準Markdown
o PHP拡張
o GitHub拡張MarkDown
o Qiita拡張MarkDown
• デファクトスタンダードo GitHub拡張MarkDown
• 対応しているエディタが多い
o SublimeText , Atom , Kobito , MarkdownPad , etc.
GitHub拡張MarkDownに一言• 定義付きリストの書き方がダサい!
http://qiita.com/Qiita/items/c686397e4a0f4f11683d
出典: Qiita - Markdown記法チートシート
HTMLそのままとは…
タグ書きたくないし!
pandoc• コマンドベースのドキュメントコンバータ
• 変換できるフォーマットは・・・とても多いですo HTML, XHTML, HTML5
o MarkdownText
o Tex, LaTex, ConTex
o PDF
o DOCX
o EPUB
o MediaWiki …他
• 中でも、MarkDownの変換機能が豪華o Markdown標準 , GitHub拡張 , PHP拡張 , pandoc拡張
o ベースのルールから文法を足したり引いたりできる
• 例) GitHub拡張に定義リストを加えたい⇒markdown_github+definition_lists
• テンプレートを指定可能公式サイト:http://johnmacfarlane.net/pandoc/
日本語ドキュメント:http://sky-y.github.io/site-pandoc-jp/users-guide/
使い方• コマンドラインで一発
• コマンド長い!!(#ノ゜д゜)ノ 凸
そこで…
pandoc hoge.md -t html5 -f markdown_github+definition_lists \--template=template.html -c css/a.css -c css/b.css -c css/c.css \--toc --toc-depth=4 -s -o hoge.html
テンプレートキット作りました
• テンプレートはとりあえずBootstrapに対応
• Markdownの書式はGitHub拡張 + 定義リスト
• バッチファイルでHTML 一発生成
https://github.com/m2wasabi/pandoc-authoring-template
http://goo.gl/mSpTe1
短縮
導入事例• Zugyuuun!!
o 導入ページ
• リファレンス
• チュートリアル
o 管理方法
• 原稿管理用Gitリポジトリ↓
バッチでhtml生成↓
webサイト管理用Git
リポジトリにコミット↓
内部Previewに自動デプロイ↓
問題なければ本番デプロイ
https://www.zugyuuun.com/http://goo.gl/mSpTe1