Mindoc is a self-hosted documentation portal and API documentation management system built as a Golang web application. It serves as a markdown documentation engine for authoring, organizing, and sharing technical interface documentation and database dictionaries. The system persists project data and user accounts using MySQL or SQLite databases.
The platform distinguishes itself by integrating diagrams-as-code rendering via Mermaid syntax, allowing flowcharts, sequence diagrams, and Gantt charts to be generated directly from text. It supports a flexible content pipeline that combines markdown authoring with custom HTML embedding and provides the ability to export projects into PDF and Word formats.
The system includes comprehensive tools for collaborative technical writing, including role-based access control, project space cloning, and team-based editing. It provides administrative oversight through document permission management, comment moderation, and project privacy controls secured by unique tokens.
Deployment options include containerized environments using Docker, as well as automated shell scripts for Linux and Windows environments.