1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

(WIP)プロジェクトドキュメントをプレーンテキストで管理できるツールまとめ

Posted at

プロジェクトドキュメントをプレーンテキストで管理できるツールまとめました。
コメント等で情報をいただければ適宜更新していこうと思います。

ツール

MkDocs

個人的にとても気に入って使ってるプロジェクトドキュメント管理ツールの一つ。
書き方が直感的で覚えやすくて皆んなに書いてもらいやすいツールだなー、と思っております。

特にマテリアルデザインに対応した Material for MkDocs と組み合わせて使うのが好き。

今の会社ではMkDocsで3つくらい管理してる。

Sphinx

Pythonのドキュメントでお馴染みのやつですね。
sphinx_rtd_themeがよく使われている印象。

↓こんなん↓(例:phpMyAdmin
image.png

やっぱりPython系が多いですが、いろんなプロジェクトで使われてますね。

ただ MkDocs に比べて書き味が悪かったので見送りました。(ただの個人的感想です)

Pandoc

公式
https://pandoc.org/MANUAL.html

日本語版(by 日本ユーザーグループ)
https://pandoc-doc-ja.readthedocs.io/ja/latest/users-guide.html

Jekyll

GitHubページでお馴染みのやつ。使ったことはない。

Hugo

知らなかった。ドキュメント生成ツールというよりはHPとかの作成に向いてそう。

Read the Docs

これも知らなかった。要調査。

DockFx

無限に出てくるなー。

docsify

T.B.D

VuePress

T.B.D

Pelican

ん?これSphinxじゃね?

Docute

もはや静的サイトジェネレーターではなくなってしまった。

比較表

T.B.D

1
1
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
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?