{"repo":"docat-org/docat","free":true,"listed":false,"github":"https://github.com/docat-org/docat","clone":"git clone https://github.com/docat-org/docat.git","description":"Host your docs. Simple. Versioned. Fancy.","language":"TypeScript","stars":903,"topics":["docs","hosting","fancy","versioning","selfhosted","hacktoberfest"],"license":"MIT","category":"self-hosted-apps","readme_excerpt":"Host your docs. Simple. Versioned. Fancy. Why DOCAT? When generating static documentation using mkdocs, sphinx, ... hosting just one version of the docs might not be enough. Many users might still use older versions and might need to read those versions of the documentation. Docat solves this problem by providing a simple tool that hosts multiple documentation projects with multiple versions. The main design decision with docat was to keep the tool as simple as possible. Getting started The simplest way to get started is to run the docker container, you can optionally use volumes to persist state: Go to localhost:8000 to view your docat instance: Using DOCAT 🛈 Please note that docat does not provide any way to write documentation. It's sole responsibility is to host documentation. There are many awesome tools to write documenation: - mkdocs - sphinx - mdbook - ... A CLI tool called docatl is available for easy interaction with the docat server. However, interacting with docat can also be done through curl . To push documentation (and tag as latest ) in the folder docs/ simply run: More detailed instructions can be found in the getting started guide . Authentication By default, anyone can upload new documentation or add a new version to documentation. A project can be claimed. A claim returns a token that then must be used to add or delete versions. When hosting docat publicly, it is recommended to use http basic auth for all POST / PUT and DELETE http calls. docat http basic","default_branch":null,"files":null,"tree":[],"storefront":"/r/docat-org","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/docat-org/docat/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}