docat
一个简单、支持多版本的文档托管工具,让你像管理代码一样管理文档版本。
スマートダウンロード
プロジェクトのホームページへ
インストーラはまだありません — ソースリポジトリをご覧ください
一键 Docker 部署,轻松托管多版本文档。
主な機能
- 支持多个项目及每个项目的多个版本
- 通过 Docker 一键部署,两分钟即可上线
- 提供 CLI 客户端 docatl,一键上传文档
- 支持项目认领和令牌认证,保证上传安全
- 支持自定义页面页眉页脚,适配品牌风格
できないこと
- •默认不开启身份认证,任何知道服务地址的人都可以上传文档。若要在公网部署,务必配置 Nginx 的 HTTP Basic Auth(详见 README)。另外,DOCAT 只负责托管文档,并不提供文档编写功能,你需要先用 mkdocs 等工具生成静态文件。
使用例
- 为软件的不同版本(如 v1.0、v2.0)分别托管对应的用户手册
- 企业内部团队使用,无需依赖第三方文档托管平台
- 开源项目展示文档,同时保留旧版本文档供用户查阅
詳細説明
DOCAT 是一款轻量级、自托管的文档托管服务器,专为需要维护多个文档版本的项目或团队设计。它无缝兼容 mkdocs、Sphinx、mdBook 等静态站点生成器。只需一条 Docker 命令,即可获得一个功能完善的文档托管平台。支持通过令牌认领项目、提供 CLI 工具(docatl)轻松上传文档,并允许通过配置文件自定义页眉页脚。与 Read the Docs 等托管服务不同,DOCAT 让您完全掌控数据,非常适合内部企业文档或对隐私有严格要求的项目。
トラブルシューティング & FAQ (1)
トラブル対応docatは.zipの代わりに.tarや.tar.gzファイルのアップロードをサポートしていますか?
いいえ、docatはアップロードに.zipファイルのみを受け付けます。ビルド環境にzipコマンドがない場合は、docatプロジェクトのdocatl CLIツールを使用して、ドキュメントをzipにパッケージ化してください。docatlはバイナリとしてコンテナに追加できます。詳細は https://github.com/docat-org/docatl をご覧ください。
タグ
はじめ方
ソフトウェアをインストール
ダウンロードしたインストーラをダブルクリックし、指示に従ってください
步骤1:在本地创建持久化目录(如 mkdir -p docat-run/doc)
步骤2:运行 Docker 命令启动容器(端口8000,挂载目录)
步骤3:打开浏览器访问 http://localhost:8000,即可看到默认界面
- 步骤1:在本地创建持久化目录(如 mkdir -p docat-run/doc)
- 步骤2:运行 Docker 命令启动容器(端口8000,挂载目录)
- 步骤3:打开浏览器访问 http://localhost:8000,即可看到默认界面
チェックサムがありません
このプロジェクトは GitHub Release ページに SHA-256 チェックサムを公開していません
SHA256 チェックサム
チェックサムなし
GitHub Releases から直接ダウンロードし、ファイルの整合性をご自身で確認してください
本プラットフォーム上のすべての SHA-256 チェックサムは、プロジェクトの公式 GitHub Release ページから抽出されたもので、一切の改変はありません。GitHub Releases ページで独自に検証できます。
オープンソースの透明性
GitHub ソースを見るアンインストール情報
停止并删除 Docker 容器:docker stop docat && docker rm docat;然后删除本地持久化数据目录(默认为 docat-run/)即可完全卸载。
追加の依存関係なし
ダウンロード後すぐに使用可能。追加のランタイムは不要です。
問題が発生?以下のFAQを確認
1 FAQ