主要观点总结
本文介绍了Docat,这是一个用于托管文档的平台,支持简单、版本化和高级功能。文章详细描述了Docat的安装过程,包括在群晖上以Docker方式安装的具体步骤,以及通过docker-compose进行安装的方法。同时,也介绍了如何使用命令行应用程序docatl和UNIX命令行工具curl对文档进行推送和管理。最后,文章强调了Docat适合静态HTML文档以及使用mkdocs、sphinx等工具生成的文档的托管。
关键观点总结
关键观点1: Docat是一个用于托管文档的平台,具有简单、版本化和高级功能。
Docat能够与常见的文档生成工具无缝集成,如MkDocs和Sphinx。无论是技术手册、API文档还是用户指南,Docat都能提供一个直观的查看和导航体验。
关键观点2: Docat可以通过Docker在群晖上安装和运行。
安装步骤包括下载镜像、新建文件夹、进入docat目录、运行容器等。同时,也可以通过docker-compose进行安装,包括配置docker-compose.yml文件和执行相关命令。
关键观点3: Docat支持通过命令行应用程序docatl和UNIX命令行工具curl进行文档推送和管理。
可以通过这两个工具对文档的版本进行标记和推送,实现文档的管理和更新。
关键观点4: Docat适合静态HTML文档和使用mkdocs、sphinx等工具生成的文档的托管。
文章还介绍了如何在浏览器中查看和使用Docat托管的文档,包括上传文档、填写项目名称、选择文档压缩包等操作。
文章预览
什么是 Docat ? Docat 是一个用于托管文档的平台,它支持简单、版本化和高级功能。能够与常见的文档生成工具(如 MkDocs 和 Sphinx )无缝集成。无论是技术手册、 API 文档还是用户指南, Docat 都能提供一个直观的查看和导航体验。 安装 在群晖上以 Docker 方式安装。因为镜像发布在 ghcr.io ,所以采用命令行方式安装 需要用 SSH 客户端登录到群晖后再执行 # 下载镜像 docker pull ghcr.io/docat-org/docat:latest docker hub 上的 randombenj/docat 从 tags 看,很可能是官方的同步发布 docker cli 安装 如果你熟悉命令行,可能用 docker cli 更快捷 # 新建文件夹 docat 和 子目录 mkdir -p /volume1/docker/docat/doc # 进入 docat 目录 cd /volume1/docker/docat # 运行容器 docker run -d \ --restart unless-stopped \ --name docat \ -p 5066:80\ -v $( pwd )/:/var/docat/ \ ghcr.io/doc
………………………………