# MinimalDoc

> A minimal static site generator for documentation. Fast, clean, and easy to use.

## Features

- [Feature Index](https://minimaldoc.com/features/index.html): Complete list of all MinimalDoc features
- [Features Overview](https://minimaldoc.com/features/overview.html): Complete feature list and capabilities of MinimalDoc
- [Search](https://minimaldoc.com/features/search.html): Client-side full-text search with keyboard shortcuts
- [Theming](https://minimaldoc.com/features/theming.html): Customize appearance with CSS variables and custom themes
- [Admonitions](https://minimaldoc.com/features/admonitions.html): Callout blocks for important information, warnings, and tips
- [Code Highlighting](https://minimaldoc.com/features/code-highlighting.html): Syntax highlighting for 100+ programming languages
- [SEO](https://minimaldoc.com/features/seo.html): Search engine optimization features including sitemap, meta tags, and Open Graph
- [LLMs.txt](https://minimaldoc.com/features/llms-txt.html): Generate LLM-friendly documentation for AI assistants
- [Landing Pages](https://minimaldoc.com/features/landing-pages.html): Create beautiful landing pages, portfolios, and contact pages
- [Multi-Version Documentation](https://minimaldoc.com/features/multi-version.html): Maintain documentation for multiple software versions with version-specific content and overrides
- [Internationalization (i18n)](https://minimaldoc.com/features/i18n.html): Multi-language documentation with locale-specific translations, RTL support, and language switching
- [Analytics](https://minimaldoc.com/features/analytics.html): Plugin-based analytics system with support for multiple providers
- [Backend Server (Optional)](https://minimaldoc.com/features/backend.html): Self-hosted backend for analytics, feedback, and newsletter features
- [Forum (Optional)](https://minimaldoc.com/features/forum.html): Community discussion forum with categories, topics, replies, reputation, and moderation
- [MCP Server Documentation](https://minimaldoc.com/features/mcp-docs.html): Publish static reference pages for MCP servers from JSON manifests
- [PDF Export](https://minimaldoc.com/features/pdf-export.html): Export documentation pages as PDF files
- [Claude Assist](https://minimaldoc.com/features/claude-assist.html): Add an AI assistant button to documentation pages
- [Waitlist](https://minimaldoc.com/features/waitlist.html): Pre-launch landing page with email signup

## Api Reference

- [CLI Commands](https://minimaldoc.com/api-reference/cli.html): Command-line interface reference
- [Config Schema](https://minimaldoc.com/api-reference/config-schema.html): Complete config.yaml schema reference
- [Templates](https://minimaldoc.com/api-reference/templates.html): Starter templates for documentation content

## Changelog

- [Changelog Overview](https://minimaldoc.com/changelog/overview.html): Track releases with versioned changelog
- [Changelog Format](https://minimaldoc.com/changelog/format.html): Release file format, categories, and semver

## Core Concepts

- [Project Structure](https://minimaldoc.com/core-concepts/project-structure.html): Understanding MinimalDoc directory layout and file organization
- [Markdown Syntax](https://minimaldoc.com/core-concepts/markdown-syntax.html): Supported Markdown syntax and GitHub Flavored Markdown extensions
- [Frontmatter](https://minimaldoc.com/core-concepts/frontmatter.html): YAML frontmatter schema for page metadata and configuration
- [Navigation](https://minimaldoc.com/core-concepts/navigation.html): Configure navigation with folder structure or custom TOC.md

## Getting Started

- [Installation](https://minimaldoc.com/getting-started/installation.html): Install MinimalDoc on your system
- [Quick Start](https://minimaldoc.com/getting-started/quick-start.html): Create your first MinimalDoc site in minutes
- [Configuration](https://minimaldoc.com/getting-started/configuration.html): Complete config.yaml reference for MinimalDoc

## Guides

- [Deployment](https://minimaldoc.com/guides/deployment.html): Deploy MinimalDoc sites to any static hosting
- [GitHub Pages](https://minimaldoc.com/guides/github-pages.html): Deploy documentation to GitHub Pages
- [Custom Themes](https://minimaldoc.com/guides/custom-themes.html): Create custom themes with CSS variables
- [Prometheus Integration](https://minimaldoc.com/guides/prometheus-integration.html): Automate status page updates with Prometheus AlertManager
- [Roadmap Pages](https://minimaldoc.com/guides/roadmap-pages.html): Add a visual roadmap to your documentation site
- [Portfolio](https://minimaldoc.com/guides/portfolio.html): Project showcase with filterable tags and individual project pages
- [Knowledge Base](https://minimaldoc.com/guides/knowledge-base.html): Categorized help articles with search and structured navigation
- [FAQ Pages](https://minimaldoc.com/guides/faq.html): Frequently asked questions with categories and collapsible answers
- [Contact Page](https://minimaldoc.com/guides/contact-page.html): Add a contact page with info cards
- [Legal Pages](https://minimaldoc.com/guides/legal-pages.html): Privacy policy, terms of service, and other legal pages

## Openapi

- [OpenAPI Overview](https://minimaldoc.com/openapi/overview.html): Interactive API documentation from OpenAPI/Swagger specifications
- [OpenAPI Configuration](https://minimaldoc.com/openapi/configuration.html): Configure OpenAPI documentation generation
- [OpenAPI Views](https://minimaldoc.com/openapi/views.html): Organize API endpoints by path, tag, or flat list
- [API Testing](https://minimaldoc.com/openapi/testing.html): Interactive API testing with Try It interface
- [Authentication](https://minimaldoc.com/openapi/authentication.html): Configure API authentication for testing
- [Code Samples](https://minimaldoc.com/openapi/code-samples.html): Auto-generated code examples for API endpoints
- [Schemas](https://minimaldoc.com/openapi/schemas.html): Browse and explore API data models

## Status Page

- [Status Page Overview](https://minimaldoc.com/status-page/overview.html): Service health dashboard with incidents and uptime tracking
- [Components](https://minimaldoc.com/status-page/components.html): Define and configure service components
- [Incidents](https://minimaldoc.com/status-page/incidents.html): Document and track service incidents
- [Scheduled Maintenance](https://minimaldoc.com/status-page/maintenance.html): Plan and communicate maintenance windows
- [Uptime Tracking](https://minimaldoc.com/status-page/uptime-tracking.html): Track service availability with uptime grid and SLA display
- [Health Checks](https://minimaldoc.com/status-page/health-checks.html): Static and real-time approaches to service monitoring

## Documentation

- [MinimalDoc](https://minimaldoc.com/index.html): A modern, minimal static site generator for beautiful documentation

## Optional

- [Complete Documentation](https://minimaldoc.com/llms-full.txt): All documentation in a single file