teedoc
MarkdownやJupyter Notebookから静的なドキュメントサイトを生成するツールです。
teedocとは
teedocは、複数のドキュメントに対応したWikiフレンドリーな静的ドキュメントサイトジェネレータです。Markdown形式のファイルやJupyter Notebookの内容を変換してHTMLウェブサイトとして出力することができます。CSSを用いてスタイルを調整できるため、カスタマイズ性の高い文書公開が可能です。多機能なドキュメント生成ツールとして、技術的な情報の整理に適しています。
要点: MarkdownやJupyter Notebookから静的なドキュメントサイトを生成するツールです。
主な用途
- 技術ドキュメントのWeb公開
- Jupyter Notebookの結果を含むマニュアル作成
- 社内Wikiの静的サイト化
- Markdownによる製品仕様書の公開
- マルチドキュメント構成のヘルプページ構築
teedocを使ったシステム開発
teedocは、そのまま納品する完成品ではなく、システムを作るための道具です。teedocを組み込んだ自社向けの仕組みを、AIエージェントと対話しながら実装します。要件を伺ってから最短1営業日で動くデモをお出しし、触って確認いただいてから発注を判断できます。完成後はソースコードごとお渡しします。
teedocを使った開発を相談teedocの日本語対応(実測)
teedocのリポジトリには日本語ロケールのファイルが9件あります。日本語で使える見込みがありますが、訳が全画面に行き渡っているか、用語が自社の言い回しに合うかは別途の確認が必要です。
見つかったファイル(一部)
plugins/teedoc-plugin-search/teedoc_plugin_search/locales/japlugins/teedoc-plugin-search/teedoc_plugin_search/locales/ja/LC_MESSAGESplugins/teedoc-plugin-search/teedoc_plugin_search/locales/ja/LC_MESSAGES/messages.poplugins/teedoc-plugin-theme-default/teedoc_plugin_theme_default/locales/japlugins/teedoc-plugin-theme-default/teedoc_plugin_theme_default/locales/ja/LC_MESSAGES
GitHubの公開ファイル一覧から、日本語ロケールに当たるファイルを数えた結果です。配布用にまとめたビルド成果物は除いています。調査日時点の内容で、翻訳の網羅率や品質までは示しません。
teedocの基本情報
| ライセンス | MIT |
|---|---|
| 主な言語 | CSS |
| GitHubスター | 267(サイト構築・静的生成カテゴリ 45件中 29位) |
| 初回公開 | 2021年1月 |
| 最終更新 | 2025年5月 |
| 日本語ロケール | 日本語ファイルあり(9ファイル) |
teedocを使った開発のよくある質問
どのようなファイル形式をサポートしていますか?
MarkdownファイルおよびJupyter Notebookのファイルをサポートしており、これらをHTMLウェブサイトへと変換することが可能です。
このツールで作成したサイトのデザインは変更できますか?
CSSを主な言語として使用しているため、スタイルシートを通じてドキュメントサイトの外観を調整することができます。
複数のドキュメントをまとめて公開することは可能ですか?
はい、多ドキュメント(multi docs)フレンドリーな設計となっており、複数の文書を整理してサイトとして構成することが可能です。
Wikiのような形式で利用できますか?
Wikiと親和性の高い静的ドキュメント生成ツールとして設計されているため、Wiki形式の情報をWebサイトとして公開するのに適しています。
teedocを使って何が作れますか?
teedocの標準機能を土台に、自社データとの連携、画面、自動処理、通知などを組み合わせた仕組みを作れます。用途を伺えば、実現できる範囲と進め方を具体的にお伝えします。
teedocを使った開発を依頼できますか?
可能です。要件と稼働環境を確認し、最短1営業日で動くデモをお出しします。発注後はサーバー設置と稼働確認まで一つの流れで対応し、ソースコードごとお渡しします。
サイト構築・静的生成の他のOSSと比べる
同じカテゴリから、スター数・ライセンス・日本語対応を並べました。
