展示HN:Brodocs 深度本地知识收集器
嗨,HN,
分享一个本地版本的Markdown知识收集器和发布工具 [https://brodocs.io](https://brodocs.io)。它可以轻松地从多个Git仓库(如微服务/纳米服务、Terraform模块、Ansible角色、架构文档)设置内部技术文档门户。
要开始使用,只需运行以下命令:
```bash
docker run -it --rm --name brodocs -p20000:20000 ghcr.io/brodocsdev/brodocs:0.14.0
```
然后从Git仓库初始化某个站点:
```bash
curl -X POST 'http://localhost:20000/api/sites/init' -F "repo=https://github.com/brodocsdev/docs.git"
```
接着访问:
[http://localhost:20000/10b0eb6e1dc27c0babd/docs/README.html](http://localhost:20000/10b0eb6e1dc27c0babd/docs/README.html)
已经构建的功能包括:
- 可以通过 `-F "repo=url"` 和 `-F "repo=url2"` 添加更多的仓库进行初始化。
- 如果需要密钥,可以使用 `-F "key=..."`,密钥会在容器中加密存储。
- 每5分钟检查一次变更,因此无需设置CI/CD管道,只需将其放在虚拟机或K8s上即可。
- 内置PlantUML转换,无需提交图像(由于需要Chrome,Mermaid仍未实现,容器大小超过1GB)。
- 构建跨团队站点,带有顶部菜单:[https://brodocs.io/d248c24a335845277b6/docs/Multisites%20with%20top%20menu.html](https://brodocs.io/d248c24a335845277b6/docs/Multisites%20with%20top%20menu.html)
欢迎提出关于在MCP上暴露哪些操作、如何构建llm.txt的建议。
查看原文
Hi HN,<p>Sharing onprem version of markdown knowledge harvester and publisher <a href="https://brodocs.io" rel="nofollow">https://brodocs.io</a>. It should make easy setting up internal tech docs portals from multiple git repos like micro/nano services, terraform modules, ansible roles, arch docs.<p>To start just: docker run -it --rm --name brodocs -p20000:20000 ghcr.io/brodocsdev/brodocs:0.14.0<p>then init some site from git repository: curl -X POST 'http://localhost:20000/api/sites/init' -F "repo=<a href="https://github.com/brodocsdev/docs.git" rel="nofollow">https://github.com/brodocsdev/docs.git</a>"<p>then go to: http://localhost:20000/10b0eb6e1dc27c0babd/docs/README.html<p>Features already built:<p>- add more repos to init with -F "repo=url" -F "repo=url2" ...<p>- if key is needed: -F "key=...", it is stored encrypted in container<p>- it will check for changes every 5 minutes, so no need to setup ci/cd pipilines, just drop it on vm or k8s<p>- PlantUML conversion built-in, no need to commit image (mermaid still missing since it needs chrome, container size goes over 1GB),<p>- building cross team sites with top menu: <a href="https://brodocs.io/d248c24a335845277b6/docs/Multisites%20with%20top%20menu.html" rel="nofollow">https://brodocs.io/d248c24a335845277b6/docs/Multisites%20wit...</a><p>Any suggestions what operations expose on MCP, how to construct llm.txt, are welcome.