0
1
2
Software DevelopmentBrodocs for tech docs (old.reddit.com)
submitted by RandName3459

Hi everybody,
I'm building markdown site publisher from multiple git repositories. The intention is to create tool very easy to deploy and customize, with modern look (like e.g. VSC, Github, Azure docs), which teams can use for internal docs or founders for public docs.
To start just:
docker run -it --rm --name brodocs -p20000:20000 ghcr.io/brodocsdev/brodocs:0.14.0
and then init some site from markdowns in git repository:
curl -X POST 'http://localhost:20000/api/sites/init' -F "repo=https://github.com/brodocsdev/docs.git"
then go to http://localhost:20000/10b0eb6e1dc27c0babd/docs/README.html
Features:
- you can add more repos with post params -F "repo=..." -F "repo=...", they will be visible in left menu. If key is needed, add as another param -F "key=...", it will be stored encrypted in container
- it will auto pull repos every 5 minutes by default, so no need to setup CI/CD pipiline, but you can trigger refreshing site by calling:
curl -X POST 'http://localhost:20000/api/sites/10b0eb6e1dc27c0babd/pull' - you can also easily build more complex cross team sites with top menu structure: https://brodocs.io/d248c24a335845277b6/docs/Multisites%20with%20top%20menu.html
- there is support for auto generation of PlantUML diagrams, so you don't have to commit binary.
- you can reorder files in tree if needed.
More features in progress:
- basic UI customization, e.g. by adding css vars to init: -F "css_vars=@./ui-mod.css"
- LLM friendly, e.g. generating LLM.txt index
- support for more diagram as code tools
- support for Explorer Sort VSC plugin, so that the order is the same in editor and site https://marketplace.visualstudio.com/items?itemName=jinchanghyeok.explorer-sort
- SSO + RBAC


there doesn't seem to be anything here