mindoc-org/mindoc

Features

• API Documentation Systems - Serves as a centralized platform for authoring, organizing, and sharing technical interface documentation and database dictionaries.
• Markdown-Based Content Authoring - Uses a lightweight markup language for authoring and managing technical documentation and API dictionaries.
• Self-Hosted Documentation Tooling - A private documentation site with user authentication, role-based access control and PDF export capabilities.
• Self-Hosted Knowledge Bases - Provides a private, self-hosted platform for managing technical knowledge with local database storage.
• Markdown Documentation - Uses a documentation system that renders technical content from Markdown, custom HTML, and Mermaid diagrams.
• Technical Writing Tools - Offers a specialized writing environment for authoring technical content using Markdown with team collaboration tools.
• Technical Documentation - Provides a centralized system for creating and organizing technical interface documentation and database dictionaries.
• Markdown Site Publishing - Transforms Markdown files and Mermaid diagrams into a structured web presence or downloadable PDF and Word files.
• Markdown to HTML Converters - Transforms Markdown plaintext markup into structured HTML for web-based documentation display.
• Mermaid Diagram Renderers - Renders flowcharts, sequence diagrams, and Gantt charts using Mermaid syntax embedded within Markdown.
• Permission Management - Provides programmatic control over access roles and sharing settings for collaborative documentation.
• Role-Based Access Control - Implements a system for managing user permissions and restricting system functionality based on assigned administrative roles.
• Permissioned Sharing Links - Generates shareable, permissioned links to allow internal or external users to access specific project documentation.
• Team Collaboration Management - Provides administrative tools for managing project members, assignments, and access controls for shared workspaces.
• Document Templating Systems - Provides custom templates at global or document-specific levels to maintain consistent formatting across technical documentation.
• Multi-Format Document Exports - Converts documentation and projects into multiple downloadable formats, including PDF and Word.
• Data Persistence Layers - Provides a configurable data persistence layer that supports both MySQL and SQLite databases.
• Relational Database Backends - Supports interchangeable relational database backends, specifically MySQL and SQLite, for persisting application data.
• Markdown Note Importers - Ingests existing documentation into the system via Markdown files or compressed archive packages.
• Project Privacy Tokens - Protects private project spaces by requiring unique security tokens for unauthorized or external access.
• Project Visibility Control - Provides mechanisms to toggle project visibility between public and private states and secure restricted access with tokens.
• Site Visibility Controls - Controls global site visibility and security settings, including anonymous access and captcha requirements for the portal.
• Go Web Applications - Implemented as a server-side web application using the Go programming language and Beego framework.

Star history