LoginSignup
8
7

More than 5 years have passed since last update.

Sphinx+PlantUML+Browser-Syncでサクサクドキュメント開発

Last updated at Posted at 2015-06-10

タイトルまんまなんだけど。

SphinxとPlantUMLとGulpとBrowser-Syncでドキュメントをサクサク書けるようにしてみた。
https://github.com/sonodar/sphinx-plantuml-browsersync

Windowsでも可。npmやpipのインストールでコケる場合はMSBuildにパスを通す必要があるかも。

以下、各要素の概要。

Sphinx

reStructureTextというMarkdownみたいな記法でドキュメントを生成するコマンドラインツール。Python製。

PlantUML

独自の記法(DSL)で記載したテキストをUMLの図に変換するコマンドラインツール。Java製。

Browser-Sync

HTMLファイル等の変更をリアルタイムにブラウザに反映させるNode.js製のライブラリ。

上記とGulpのファイル変更検知機能(watch)と併せて利用することでドキュメントを編集した内容がブラウザに即時反映されるようにしている。

8
7
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
8
7