okf_version: 0.9.6 bundle: name: docmd-docs title: "docmd docs" description: "" url: "https://docs.docmd.io" generated_by: "@docmd/plugin-okf" generated_at: "2026-09-21T10:55:30.501Z" default_type: concept stats: concepts: 555 by_type: concept: 543 guide: 6 reference: 6 locales: - en - zh - de - es versions: - 09 - 08 - 07 - 06 - 05 - 04 concepts: - id: comparison type: concept title: Comparison description: "How docmd stacks up against Docusaurus, VitePress, MkDocs, Starlight, and Mintlify - real numbers, real features." path: /comparison/ file: concepts/comparison.md locale: en version: 09 tags: - id: configuration-cookie-consent type: concept title: "Cookie Consent" description: "Configure docmd's accessible GDPR cookie consent dialogue with custom expiration, localisation, and CustomEvent integrations." path: /configuration/cookie-consent/ file: concepts/configuration-cookie-consent.md locale: en version: 09 tags: - id: configuration-layout-ui type: concept title: "Layout & UI Zones" description: "Configure documentation layout regions, header widgets, sidebar trees, and footer parameters in docmd.config.json." path: /configuration/layout-ui/ file: concepts/configuration-layout-ui.md locale: en version: 09 tags: - id: configuration-localisation type: concept title: Localisation description: "Serve documentation in multiple languages with locale-first routing, translated navigation, and automatic fallback." path: /configuration/localisation/ file: concepts/configuration-localisation.md locale: en version: 09 tags: - id: configuration-localisation-translated-content type: concept title: "Translated Content & i18n Routing" description: "Organise multi-language documentation directories, fallback mechanics, and localised navigation structures in docmd." path: /configuration/localisation/translated-content/ file: concepts/configuration-localisation-translated-content.md locale: en version: 09 tags: - id: configuration-localisation-ui-strings type: concept title: "UI Strings & SEO Localisation" description: "Customise system UI strings per locale and understand automated hreflang SEO meta tags in docmd." path: /configuration/localisation/ui-strings/ file: concepts/configuration-localisation-ui-strings.md locale: en version: 09 tags: - id: configuration-menubar type: concept title: "Menubar Configuration" description: "Configure the top navigation menubar, dropdown links, brand logos, and utility menus in docmd." path: /configuration/menubar/ file: concepts/configuration-menubar.md locale: en version: 09 tags: - id: configuration-navigation type: concept title: "Navigation Configuration" description: "Structure sidebar navigation, organise categories, and configure icons for readers and search engines in docmd." path: /configuration/navigation/ file: concepts/configuration-navigation.md locale: en version: 09 tags: - id: configuration-overview type: concept title: "General Configuration" description: "Master docmd.config.json to manage branding, site metadata, routing, layout zones, and build compilers in docmd." path: /configuration/overview/ file: concepts/configuration-overview.md locale: en version: 09 tags: - id: configuration-redirects type: concept title: "Redirects & 404 Pages" description: "Configure static HTML redirects and custom branded 404 error pages in docmd." path: /configuration/redirects/ file: concepts/configuration-redirects.md locale: en version: 09 tags: - id: configuration-security type: concept title: "Security & HTML Policy" description: "Configure HTML security policies, sanitise raw HTML, control iframe embeds, and implement security best practices in docmd." path: /configuration/security/ file: concepts/configuration-security.md locale: en version: 09 tags: - id: configuration-site-banner type: concept title: "Site Banners" description: "Configure multi-position announcement and promotional banners with Markdown, images, call-to-action buttons, and session persistence in docmd." path: /configuration/site-banner/ file: concepts/configuration-site-banner.md locale: en version: 09 tags: - id: configuration-versioning type: concept title: "Versioning Engine" description: "Serve multi-version documentation with instant version switching, sticky URL path preservation, and isolated build outputs in docmd." path: /configuration/versioning/ file: concepts/configuration-versioning.md locale: en version: 09 tags: - id: configuration-workspaces type: concept title: "Multi-Project Workspaces" description: "Build and deploy multi-project documentation sites from a single repository with shared assets and project switchers in docmd." path: /configuration/workspaces/ file: concepts/configuration-workspaces.md locale: en version: 09 tags: - id: configuration-zero-config type: concept title: "Zero-Config Architecture" description: "Discover docmd's zero-config heuristics engine that automatically discovers documentation files, routes paths, and structures sites without configuration." path: /configuration/zero-config/ file: concepts/configuration-zero-config.md locale: en version: 09 tags: - id: content-containers-buttons type: concept title: Buttons description: "Inject prominent call-to-action buttons for internal SPA navigation and external links in docmd." path: /content/containers/buttons/ file: concepts/content-containers-buttons.md locale: en version: 09 tags: - id: content-containers-callouts type: concept title: Callouts description: "Highlight critical warnings, pro-tips, and background context using semantic visual blocks in docmd." path: /content/containers/callouts/ file: concepts/content-containers-callouts.md locale: en version: 09 tags: - id: content-containers-cards type: concept title: Cards description: "Organise information into framed, visually distinct containers for feature grids and landing pages in docmd." path: /content/containers/cards/ file: concepts/content-containers-cards.md locale: en version: 09 tags: - id: content-containers-changelogs type: concept title: Changelogs description: "Generate structured, timeline-based version histories and release notes in docmd." path: /content/containers/changelogs/ file: concepts/content-containers-changelogs.md locale: en version: 09 tags: - id: content-containers-collapsible type: concept title: "Collapsible Sections" description: "Embed interactive accordion toggles for FAQs, deep-dive technical data, and optional content in docmd." path: /content/containers/collapsible/ file: concepts/content-containers-collapsible.md locale: en version: 09 tags: - id: content-containers-embed type: concept title: "URL Embeds" description: "Safely embed dynamic video, social media, and interactive content using the embed-lite parser in docmd." path: /content/containers/embed/ file: concepts/content-containers-embed.md locale: en version: 09 tags: - id: content-containers-grids type: concept title: Grids description: "Organise responsive multi-column layouts using native Markdown flexbox containers in docmd." path: /content/containers/grids/ file: concepts/content-containers-grids.md locale: en version: 09 tags: - id: content-containers-hero type: concept title: "Hero Sections" description: "Build high-impact landing page headers and marketing highlights in Markdown in docmd." path: /content/containers/hero/ file: concepts/content-containers-hero.md locale: en version: 09 tags: - id: content-containers type: concept title: "Custom Interactive Containers" description: "A comprehensive directory of structural UI containers and interactive components in docmd." path: /content/containers/ file: concepts/content-containers.md locale: en version: 09 tags: - id: content-containers-mermaid type: concept title: "Mermaid Diagrams" description: "Render flowcharts, sequence diagrams, and architecture maps using the explicit ::: mermaid container or standard Markdown code blocks." path: /content/containers/mermaid/ file: concepts/content-containers-mermaid.md locale: en version: 09 tags: - id: content-containers-nested-containers type: concept title: "Nested Containers" description: "Combine cards, tabs, callouts, and steps recursively into high-fidelity page layouts in docmd." path: /content/containers/nested-containers/ file: concepts/content-containers-nested-containers.md locale: en version: 09 tags: - id: content-containers-steps type: concept title: Steps description: "Convert numbered steps and ordered lists into high-impact visual timelines and tutorials in docmd." path: /content/containers/steps/ file: concepts/content-containers-steps.md locale: en version: 09 tags: - id: content-containers-tabs type: concept title: Tabs description: "Organise alternative code snippets, platform instructions, and multi-language content into switchable tabs in docmd." path: /content/containers/tabs/ file: concepts/content-containers-tabs.md locale: en version: 09 tags: - id: content-containers-tags type: concept title: Tags description: "Use tag containers to label versions, statuses, or highlight short text snippets inline in docmd." path: /content/containers/tags/ file: concepts/content-containers-tags.md locale: en version: 09 tags: - id: content-containers-tooltip type: concept title: "Tooltip Container" description: "Learn how to use inline and block tooltip containers in docmd to render hover popovers and clickable term explanations." path: /content/containers/tooltip/ file: concepts/content-containers-tooltip.md locale: en version: 09 tags: - id: content-frontmatter type: concept title: "Frontmatter Reference" description: "Configure page-level metadata, search indexing, layout overrides, and component controls in docmd." path: /content/frontmatter/ file: concepts/content-frontmatter.md locale: en version: 09 tags: - id: content-live-preview type: concept title: "Live Preview" description: "Run the docmd engine entirely in the browser using the @docmd/live browser compiler architecture in docmd." path: /content/live-preview/ file: concepts/content-live-preview.md locale: en version: 09 tags: - id: content-no-style-example type: concept title: "docmd : Bespoke No-Style Page Demo" description: "A functional demonstration of the noStyle architectural feature." path: /content/no-style-example/ file: concepts/content-no-style-example.md locale: en version: 09 tags: - id: content-no-style-pages type: concept title: "No-Style Pages" description: "Create custom landing pages and unique layouts by bypassing default documentation chrome in docmd." path: /content/no-style-pages/ file: concepts/content-no-style-pages.md locale: en version: 09 tags: - id: content-syntax-advanced type: concept title: "Advanced Markdown Syntax" description: "Master extended GFM features: task lists, element attributes, footnotes, definition lists, and abbreviations in docmd." path: /content/syntax/advanced/ file: concepts/content-syntax-advanced.md locale: en version: 09 tags: - id: content-syntax-code type: concept title: "Code Blocks & Highlighting" description: "Document technical implementations with high-performance syntax highlighting, code block titles, and copy controls in docmd." path: /content/syntax/code/ file: concepts/content-syntax-code.md locale: en version: 09 tags: - id: content-syntax-images type: concept title: "Images & Visual Media" description: "Embed responsive images, apply attribute classes for sizing and alignment, and configure interactive lightboxes in docmd." path: /content/syntax/images/ file: concepts/content-syntax-images.md locale: en version: 09 tags: - id: content-syntax type: concept title: "Markdown Syntax Foundation" description: "Master baseline Markdown typography, heading hierarchy, lists, tables, and raw HTML extensions in docmd." path: /content/syntax/ file: concepts/content-syntax.md locale: en version: 09 tags: - id: content-syntax-linking type: concept title: "Linking & Referencing" description: "Master internal cross-linking, URL normalisation, external new-tab triggers, and static asset references in docmd." path: /content/syntax/linking/ file: concepts/content-syntax-linking.md locale: en version: 09 tags: - id: deployment-caddy type: concept title: "Caddy Server Deployment" description: "Deploy docmd documentation using Caddy web server with automatic TLS certificate provisioning." path: /deployment/caddy/ file: concepts/deployment-caddy.md locale: en version: 09 tags: - id: deployment-cloudflare-pages type: concept title: "Cloudflare Pages Deployment" description: "Deploy docmd static documentation sites to Cloudflare Pages edge hosting." path: /deployment/cloudflare-pages/ file: concepts/deployment-cloudflare-pages.md locale: en version: 09 tags: - id: deployment-deployer type: concept title: Deployer description: "Generate production deployment configurations for Docker, NGINX, Caddy, Vercel, and Netlify directly from docmd.config.json." path: /deployment/deployer/ file: concepts/deployment-deployer.md locale: en version: 09 tags: - id: deployment-docker type: concept title: "Docker Containerisation" description: "Run docmd within containerised environments using official images or generated Dockerfiles." path: /deployment/docker/ file: concepts/deployment-docker.md locale: en version: 09 tags: - id: deployment-firebase type: concept title: "Firebase Hosting Deployment" description: "Deploy static docmd documentation to Firebase Hosting manually or via GitHub Actions." path: /deployment/firebase/ file: concepts/deployment-firebase.md locale: en version: 09 tags: - id: deployment-github-action type: concept title: "GitHub Action" description: "Build and deploy docmd documentation to GitHub Pages using the official docmd-io/deploy GitHub Action." path: /deployment/github-action/ file: concepts/deployment-github-action.md locale: en version: 09 tags: - id: deployment type: concept title: "Deployment Overview" description: "Deploy static documentation generated by docmd to zero-config templates, self-hosted web servers, Docker, or cloud platforms." path: /deployment/ file: concepts/deployment.md locale: en version: 09 tags: - id: deployment-netlify type: concept title: "Netlify Deployment" description: "Deploy docmd documentation to Netlify using generated netlify.toml configurations." path: /deployment/netlify/ file: concepts/deployment-netlify.md locale: en version: 09 tags: - id: deployment-nginx type: concept title: "NGINX Deployment" description: "Deploy compiled docmd static documentation to NGINX web servers." path: /deployment/nginx/ file: concepts/deployment-nginx.md locale: en version: 09 tags: - id: deployment-starter-template type: concept title: "Starter Template" description: "Initialise new documentation repositories using the official docmd starter template with GitHub Pages deployment." path: /deployment/starter-template/ file: concepts/deployment-starter-template.md locale: en version: 09 tags: - id: deployment-vercel type: concept title: "Vercel Deployment" description: "Deploy docmd static documentation sites to Vercel using generated vercel.json configurations." path: /deployment/vercel/ file: concepts/deployment-vercel.md locale: en version: 09 tags: - id: development-building-plugins type: concept title: "Building Plugins" description: "A comprehensive guide to extending docmd with custom logic, data injection, and interactive features." path: /development/building-plugins/ file: concepts/development-building-plugins.md locale: en version: 09 tags: - id: development-building-templates type: concept title: "Building Templates" description: "Author a docmd template package, directory layout, descriptor, EJS context, asset priorities, and API reference." path: /development/building-templates/ file: concepts/development-building-templates.md locale: en version: 09 tags: - id: development-engines-js type: concept title: "JavaScript Engine" description: "Deep explore docmd's native JavaScript execution engine: use cases, portability, capabilities, and limits." path: /development/engines/js/ file: concepts/development-engines-js.md locale: en version: 09 tags: - id: development-engines-overview type: concept title: "Engines Overview" description: "Understand the pluggable build engine architecture and select the best processing backend." path: /development/engines/overview/ file: concepts/development-engines-overview.md locale: en version: 09 tags: - id: development-engines-rust type: concept title: "Rust Engine" description: "Explore the optional native Rust engine: use cases, file I/O capabilities, supported packages, and limitations." path: /development/engines/rust/ file: concepts/development-engines-rust.md locale: en version: 09 tags: - id: development-node-api-reference type: concept title: "Node API Reference" description: "Low-level Node API for plugin authors, URL utilities, action dispatchers, source tools, the engine loader, and TypeScript types." path: /development/node-api-reference/ file: concepts/development-node-api-reference.md locale: en version: 09 tags: - id: development-plugin-examples type: concept title: "Extending docmd with Custom Plugins" description: "How to use docmd's lifecycle hooks to build custom functionality and extend the documentation engine." path: /development/plugin-examples/ file: concepts/development-plugin-examples.md locale: en version: 09 tags: - id: development-setup type: concept title: "Development Setup" description: "How to set up local development, link local framework builds, and run verification pipelines for docmd documentation." path: /development/setup/ file: concepts/development-setup.md locale: en version: 09 tags: - id: getting-started-installation type: concept title: Installation description: "Install @docmd/core globally, locally within a project, or run containerised via the official Docker image. Requires Node.js 20+." path: /getting-started/installation/ file: concepts/getting-started-installation.md locale: en version: 09 tags: - id: getting-started-project-structure type: concept title: "Project Structure" description: "Learn how `@docmd/core` maps physical folders and Markdown files to dynamic URLs and clean navigation." path: /getting-started/project-structure/ file: concepts/getting-started-project-structure.md locale: en version: 09 tags: - id: getting-started-quick-start type: concept title: "Quick Start" description: "Go from an empty directory to a running documentation site in under a minute." path: /getting-started/quick-start/ file: concepts/getting-started-quick-start.md locale: en version: 09 tags: - quickstart - setup - cli - id: guides-ai-ai-assistant type: guide title: "AI Assistant Setup & Integration" description: "How to configure and deploy docmd's interactive AI Assistant for RAG-powered documentation support." path: /guides/ai/ai-assistant/ file: concepts/guides-ai-ai-assistant.md locale: en version: 09 tags: - id: guides-ai-mcp-and-agent-skills type: guide title: "MCP & Agent Skills" description: "Configure Model Context Protocol (MCP) servers and AI agent skills for docmd workspaces." path: /guides/ai/mcp-and-agent-skills/ file: concepts/guides-ai-mcp-and-agent-skills.md locale: en version: 09 tags: - id: guides-ai-okf-bundles type: guide title: "OKF Bundles, Deep Dive" description: "How to organise your docmd content for the best OKF bundle, typed concepts, cross-links, and the discipline that makes an AI-agent-friendly knowledge base." path: /guides/ai/okf-bundles/ file: concepts/guides-ai-okf-bundles.md locale: en version: 09 tags: - id: guides-integrations-openapi-generation type: guide title: "OpenAPI Generation" description: "Integrate OpenAPI and Swagger REST schemas into docmd workflows for automated API documentation rendering." path: /guides/integrations/openapi-generation/ file: concepts/guides-integrations-openapi-generation.md locale: en version: 09 tags: - id: guides-overview type: guide title: "Guides Overview" description: "Explore technical guides for docmd, AI Assistant, MCP agent integration, OKF knowledge bundles, hybrid semantic search, and OpenAPI generation." path: /guides/overview/ file: concepts/guides-overview.md locale: en version: 09 tags: - id: guides-search-semantic-search type: guide title: "Semantic Search Integration" description: "Configure and deploy client-side hybrid semantic search in docmd using local vector embeddings." path: /guides/search/semantic-search/ file: concepts/guides-search-semantic-search.md locale: en version: 09 tags: - id: root type: concept title: "docmd Docs — Official Documentation, Guides & API Reference" description: "Open-source documentation compiler. One Markdown source, one command, generates website, search, AI context, agent protocols, and knowledge formats together." path: / file: concepts/root.md locale: en version: 09 tags: - id: migration-docusaurus type: concept title: "Migrating from Docusaurus" description: "A comprehensive guide on moving your Docusaurus v2/v3 project to docmd." path: /migration/docusaurus/ file: concepts/migration-docusaurus.md locale: en version: 09 tags: - id: migration-mkdocs type: concept title: "Migrating from MkDocs" description: "A comprehensive guide on moving your MkDocs (or Material for MkDocs) project to docmd." path: /migration/mkdocs/ file: concepts/migration-mkdocs.md locale: en version: 09 tags: - id: migration-overview type: concept title: "Migration Overview" description: "Learn how to easily migrate your existing documentation project to docmd using the built-in migration CLI engine." path: /migration/overview/ file: concepts/migration-overview.md locale: en version: 09 tags: - id: migration-starlight type: concept title: "Migrating from Astro Starlight" description: "A comprehensive guide on moving your Astro Starlight project to docmd." path: /migration/starlight/ file: concepts/migration-starlight.md locale: en version: 09 tags: - id: migration-vitepress type: concept title: "Migrating from VitePress" description: "A comprehensive guide on moving your VitePress project to docmd." path: /migration/vitepress/ file: concepts/migration-vitepress.md locale: en version: 09 tags: - id: plugins-ai type: concept title: "AI Assistant Plugin" description: "Enable interactive, search-aware AI documentation assistance powered by aiplug multi-provider integration." path: /plugins/ai/ file: concepts/plugins-ai.md locale: en version: 09 tags: - id: plugins-analytics type: concept title: "Analytics Plugin" description: "Integrate Google Analytics 4 (GA4) or legacy Universal Analytics with automated event tracking." path: /plugins/analytics/ file: concepts/plugins-analytics.md locale: en version: 09 tags: - id: plugins-git type: concept title: "Git Integration Plugin" description: "Inject Git repository intelligence, last-updated timestamps, commit history tooltips, and automated source edit links." path: /plugins/git/ file: concepts/plugins-git.md locale: en version: 09 tags: - id: plugins-llms type: concept title: "LLM Context Plugin" description: "Optimise documentation for AI agents and LLM ingestion via automated llms.txt and llms-full.txt generation." path: /plugins/llms/ file: concepts/plugins-llms.md locale: en version: 09 tags: - id: plugins-math type: concept title: "Math Plugin" description: "Native KaTeX and LaTeX mathematical expression rendering with conditional asset loading." path: /plugins/math/ file: concepts/plugins-math.md locale: en version: 09 tags: - id: plugins-mermaid type: concept title: "Mermaid Diagrams Plugin" description: "Zero-config integration for Mermaid.js diagrams with automatic theme synchronisation and lazy asset injection." path: /plugins/mermaid/ file: concepts/plugins-mermaid.md locale: en version: 09 tags: - id: plugins-okf type: concept title: "OKF Bundle Plugin" description: "Generate Open Knowledge Format (OKF) knowledge bundles and interactive concept graphs for AI agents." path: /plugins/okf/ file: concepts/plugins-okf.md locale: en version: 09 tags: - id: plugins-openapi type: concept title: "OpenAPI Plugin" description: "Static API reference documentation rendered directly from OpenAPI 3.x specifications at build-time." path: /plugins/openapi/ file: concepts/plugins-openapi.md locale: en version: 09 tags: - id: plugins-pwa type: concept title: "PWA & Offline Plugin" description: "Transform documentation portals into offline-first Progressive Web Applications with service worker caching." path: /plugins/pwa/ file: concepts/plugins-pwa.md locale: en version: 09 tags: - id: plugins-search type: concept title: "Search Plugin" description: "Enable high-speed, offline-first full-text keyword search and local semantic embeddings in docmd." path: /plugins/search/ file: concepts/plugins-search.md locale: en version: 09 tags: - id: plugins-seo type: concept title: "SEO Plugin" description: "Optimise your documentation site for search engine indexing, social card previews, and AI crawler governance." path: /plugins/seo/ file: concepts/plugins-seo.md locale: en version: 09 tags: - id: plugins-sitemap type: concept title: "Sitemap Plugin" description: "Automatically generate standard-compliant sitemap.xml files for multi-version documentation sites in docmd." path: /plugins/sitemap/ file: concepts/plugins-sitemap.md locale: en version: 09 tags: - id: plugins-threads type: concept title: "Threads Plugin" description: "Collaborative inline discussion threads and text highlighting stored natively inside Markdown files." path: /plugins/threads/ file: concepts/plugins-threads.md locale: en version: 09 tags: - id: plugins-usage type: concept title: "Using Plugins" description: "Install, configure, and manage docmd plugins, from core built-ins to optional third-party extensions." path: /plugins/usage/ file: concepts/plugins-usage.md locale: en version: 09 tags: - id: reference-browser-api type: reference title: "Browser API" description: "Client-side APIs for docmd, isomorphic rendering engine and dev-mode WebSocket plugin communication." path: /reference/browser-api/ file: concepts/reference-browser-api.md locale: en version: 09 tags: - id: reference-build-api type: reference title: "Build API" description: "Programmatic Node.js API reference for docmd, build sites, live editor bundles, and multi-project workspaces." path: /reference/build-api/ file: concepts/reference-build-api.md locale: en version: 09 tags: - id: reference-cli-commands type: reference title: "CLI Commands" description: "Command-line interface reference for docmd, commands, flags, and options for building and managing documentation." path: /reference/cli-commands/ file: concepts/reference-cli-commands.md locale: en version: 09 tags: - id: reference-client-side-events type: reference title: "Client-Side Events" description: "Subscribe to client-side lifecycle events in docmd Single Page Application (SPA) navigation." path: /reference/client-side-events/ file: concepts/reference-client-side-events.md locale: en version: 09 tags: - id: reference-live-api type: reference title: "Live Editor" description: "Architecture and execution reference for the docmd browser-based Live Editor environment." path: /reference/live-api/ file: concepts/reference-live-api.md locale: en version: 09 tags: - id: reference-mcp-server type: reference title: "MCP Server" description: "Model Context Protocol (MCP) server reference for integration with AI development tools." path: /reference/mcp-server/ file: concepts/reference-mcp-server.md locale: en version: 09 tags: - id: release-notes-0-9-0 type: concept title: "v0.9.0 Release Notes" description: "Release notes for docmd v0.9.0 - Integrated AI assistant, minimalist TUI overhaul, Cloud origin security, page-relative navigation, and offline build support." path: /release-notes/0-9-0/ file: concepts/release-notes-0-9-0.md locale: en version: 09 tags: - id: release-notes-0-9-1 type: concept title: "v0.9.1 Release Notes" description: "Release notes for docmd v0.9.1 - Standardised container engine, native ::: mermaid diagram container, explicit key-value attributes, container comments, and Issue #187 HTML rendering fix." path: /release-notes/0-9-1/ file: concepts/release-notes-0-9-1.md locale: en version: 09 tags: - id: release-notes-0-9-2 type: concept title: "v0.9.2 Release Notes" description: "Release notes for docmd v0.9.2 - AI Assistant multi-turn autonomous tool loop stabilisation, modern code block UI rendering, streaming JSON fallback parsing, and TypeScript hook typing improvements." path: /release-notes/0-9-2/ file: concepts/release-notes-0-9-2.md locale: en version: 09 tags: - id: release-notes-0-9-3 type: concept title: "v0.9.3 Release Notes" description: "Release notes for docmd v0.9.3 - Offline air-gapped Mermaid diagrams, OpenAPI response examples and schema table containment, reliable AI assistant multi-format tool parser, parser URL safety fixes, and CI verification stabilisation." path: /release-notes/0-9-3/ file: concepts/release-notes-0-9-3.md locale: en version: 09 tags: - id: release-notes-0-9-4 type: concept title: "v0.9.4 Release Notes" description: "Release notes for docmd v0.9.4 - OpenAPI dark mode styling, AI Assistant disable configuration fix, docmd-assistant v0.1.15 engine integration, parallelised test runner, and accelerated maintenance pipeline." path: /release-notes/0-9-4/ file: concepts/release-notes-0-9-4.md locale: en version: 09 tags: - id: release-notes-0-9-5 type: concept title: "v0.9.5 - AI Autonomous Tools, Threads Modernisation & Template Refinements" description: "Release notes for docmd v0.9.5 - Autonomous AI assistant tools suite, Threads collaborative discussions overhaul with inline previews, template UI refinements, and OpenAPI workspace resolution." path: /release-notes/0-9-5/ file: concepts/release-notes-0-9-5.md locale: en version: 09 tags: - id: release-notes-0-9-6 type: concept title: "v0.9.6 - Focus Mode, Multi-Position Banners, Title & SEO Architecture, OKF Enhancements & Security Upgrades" description: "Release notes for docmd v0.9.6 - Distraction-free Focus Mode, 7-position banner system with inheritance & card persistence, heading anchor link copying, image lightbox re-binding, SEO titleSeparator & JSON-LD schemas, OKF concept descriptions & tag merging, post-build asset declarations hook, security dependency CVE remediation, git ignore filtering, navigation attributes, and multi-turn AI Assistant stream replacement." path: /release-notes/0-9-6/ file: concepts/release-notes-0-9-6.md locale: en version: 09 tags: - id: theming-assets-management type: concept title: "Assets Management" description: "Learn how docmd mirrors CSS, JavaScript, and image assets from source directories to output builds." path: /theming/assets-management/ file: concepts/theming-assets-management.md locale: en version: 09 tags: - id: theming-custom-css-js type: concept title: "Custom Styles & Scripts" description: "Inject custom CSS and JavaScript files into your docmd site to extend layout styles, brand identity, and client behaviour." path: /theming/custom-css-js/ file: concepts/theming-custom-css-js.md locale: en version: 09 tags: - id: theming-customisation type: concept title: "Customisation & CSS Variables" description: "Reference guide for docmd CSS variables, visual tokens, and component classes for advanced styling." path: /theming/customisation/ file: concepts/theming-customisation.md locale: en version: 09 tags: - id: theming-favicons-metadata type: concept title: "Customising Favicons & Metadata" description: "Configure site favicons, OpenGraph cards, and Twitter metadata in docmd for social sharing and search engines." path: /theming/favicons-metadata/ file: concepts/theming-favicons-metadata.md locale: en version: 09 tags: - id: theming-fonts-branding type: concept title: "Custom Fonts & Branding" description: "Match your documentation site appearance to corporate identity guidelines using CSS variables and web fonts in docmd." path: /theming/fonts-branding/ file: concepts/theming-fonts-branding.md locale: en version: 09 tags: - id: theming-icons type: concept title: Icons description: "Integrate Lucide icons into navigation sidebars, buttons, tags, and custom components in docmd." path: /theming/icons/ file: concepts/theming-icons.md locale: en version: 09 tags: - id: theming-landing-pages type: concept title: "Designing Custom Landing Pages" description: "Build custom landing pages using hero headers, grid containers, and noStyle mode in docmd." path: /theming/landing-pages/ file: concepts/theming-landing-pages.md locale: en version: 09 tags: - id: theming-light-dark-mode type: concept title: "Light & Dark Appearance" description: "Configure light and dark mode appearance modes, custom CSS variable overrides, and theme toggle controls in docmd." path: /theming/light-dark-mode/ file: concepts/theming-light-dark-mode.md locale: en version: 09 tags: - id: theming-templates type: concept title: "Templates & Themes" description: "Configure site layout templates and built-in CSS colour schemes in docmd. Layer HTML structures, EJS partials, and visual palettes." path: /theming/templates/ file: concepts/theming-templates.md locale: en version: 09 tags: - id: 08-comparison type: concept title: Comparison description: "How docmd stacks up against Docusaurus, VitePress, MkDocs, Starlight, and Mintlify - real numbers, real features." path: /08/comparison/ file: concepts/08-comparison.md locale: en version: 08 tags: - id: 08-configuration-cookie-consent type: concept title: "Cookie Consent" description: "Opt-in cookie consent dialog shipped with the default UI. Stores the user's choice in localStorage, supports translations, and emits a docmd:cookie-consent CustomEvent so plugins and templates can react." path: /08/configuration/cookie-consent/ file: concepts/08-configuration-cookie-consent.md locale: en version: 08 tags: - id: 08-configuration-layout-ui type: concept title: "Layout & UI Zones" description: "Control the interface structure by managing headers, sidebars, and functional UI slots." path: /08/configuration/layout-ui/ file: concepts/08-configuration-layout-ui.md locale: en version: 08 tags: - id: 08-configuration-localisation type: concept title: Localisation description: "Serve documentation in multiple languages with locale-first routing, translated navigation, and automatic fallback." path: /08/configuration/localisation/ file: concepts/08-configuration-localisation.md locale: en version: 08 tags: - id: 08-configuration-localisation-translated-content type: concept title: "Translated Content" description: "Organise translations in locale subdirectories with per-file fallback and per-locale navigation." path: /08/configuration/localisation/translated-content/ file: concepts/08-configuration-localisation-translated-content.md locale: en version: 08 tags: - id: 08-configuration-localisation-ui-strings type: concept title: "UI Strings & SEO" description: "Customise system UI text per locale and understand automatic SEO tags for multi-language sites." path: /08/configuration/localisation/ui-strings/ file: concepts/08-configuration-localisation-ui-strings.md locale: en version: 08 tags: - id: 08-configuration-menubar type: concept title: Menubar description: "Structure and position your menubar, manage navigation links, and configure drop-down menus." path: /08/configuration/menubar/ file: concepts/08-configuration-menubar.md locale: en version: 08 tags: - id: 08-configuration-navigation type: concept title: "Navigation Configuration" description: "Structure your sidebar, categorise links, and configure icons for readers and search engines." path: /08/configuration/navigation/ file: concepts/08-configuration-navigation.md locale: en version: 08 tags: - id: 08-configuration-overview type: concept title: "General Configuration" description: "Configure docmd.config.json to manage branding, custom schemas, routing, layout behaviour, and build engines." path: /08/configuration/overview/ file: concepts/08-configuration-overview.md locale: en version: 08 tags: - id: 08-configuration-redirects type: concept title: "Redirects & 404" description: "Configure metadata-based redirects and custom branded 404 error pages for static deployments." path: /08/configuration/redirects/ file: concepts/08-configuration-redirects.md locale: en version: 08 tags: - id: 08-configuration-site-banner type: concept title: "Site Banner" description: "Site-wide announcement banner. Sits above the menubar, supports inline markdown, optional icon, CTA link, and per-session dismissal." path: /08/configuration/site-banner/ file: concepts/08-configuration-site-banner.md locale: en version: 08 tags: - id: 08-configuration-versioning type: concept title: Versioning description: "Enable multi-version documentation with seamless switching, sticky path preservation, and isolated build directories." path: /08/configuration/versioning/ file: concepts/08-configuration-versioning.md locale: en version: 08 tags: - id: 08-configuration-workspaces type: concept title: Workspaces description: "Build multiple independent documentation projects from a single docmd instance, with global configuration cascading and a built-in Project Switcher." path: /08/configuration/workspaces/ file: concepts/08-configuration-workspaces.md locale: en version: 08 tags: - id: 08-configuration-zero-config type: concept title: Zero-Config description: "Understand the heuristics engine of docmd that automatically structures your site without files." path: /08/configuration/zero-config/ file: concepts/08-configuration-zero-config.md locale: en version: 08 tags: - id: 08-content-containers-buttons type: concept title: Buttons description: "Inject clear, highly visible call-to-actions directly into your documentation." path: /08/content/containers/buttons/ file: concepts/08-content-containers-buttons.md locale: en version: 08 tags: - id: 08-content-containers-callouts type: concept title: Callouts description: "Highlight critical warnings, pro-tips, and background context using semantic visual blocks." path: /08/content/containers/callouts/ file: concepts/08-content-containers-callouts.md locale: en version: 08 tags: - id: 08-content-containers-cards type: concept title: Cards description: "Organise information into framed, visually distinct containers. Perfect for feature grids and landing pages." path: /08/content/containers/cards/ file: concepts/08-content-containers-cards.md locale: en version: 08 tags: - id: 08-content-containers-changelogs type: concept title: Changelogs description: "Generate structured, timeline-based version history and release notes." path: /08/content/containers/changelogs/ file: concepts/08-content-containers-changelogs.md locale: en version: 08 tags: - id: 08-content-containers-collapsible type: concept title: "Collapsible Sections" description: "Embed interactive accordion-style toggles for FAQs, deep-dive content, and spoilers." path: /08/content/containers/collapsible/ file: concepts/08-content-containers-collapsible.md locale: en version: 08 tags: - id: 08-content-containers-embed type: concept title: "URL Embeds" description: "Safely embed dynamic video, social, and interactive content directly into your documents." path: /08/content/containers/embed/ file: concepts/08-content-containers-embed.md locale: en version: 08 tags: - id: 08-content-containers-grids type: concept title: Grids description: "Organise layout into auto-adjusting responsive columns without writing HTML." path: /08/content/containers/grids/ file: concepts/08-content-containers-grids.md locale: en version: 08 tags: - id: 08-content-containers-hero type: concept title: "Hero Sections" description: "Build high-impact landing page headers and marketing highlights purely in Markdown." path: /08/content/containers/hero/ file: concepts/08-content-containers-hero.md locale: en version: 08 tags: - id: 08-content-containers type: concept title: "Custom Interactive Containers" description: "A comprehensive directory of the interactive UI building blocks available in docmd." path: /08/content/containers/ file: concepts/08-content-containers.md locale: en version: 08 tags: - id: 08-content-containers-nested-containers type: concept title: "Nested Containers" description: "Use the recursive parser to combine cards, tabs, and callouts into high-fidelity page layouts." path: /08/content/containers/nested-containers/ file: concepts/08-content-containers-nested-containers.md locale: en version: 08 tags: - id: 08-content-containers-steps type: concept title: Steps description: "Convert standard ordered lists into high-impact visual timelines and tutorials." path: /08/content/containers/steps/ file: concepts/08-content-containers-steps.md locale: en version: 08 tags: - id: 08-content-containers-tabs type: concept title: Tabs description: "Organise dense, alternative, or multi-language information into switchable interactive panes." path: /08/content/containers/tabs/ file: concepts/08-content-containers-tabs.md locale: en version: 08 tags: - id: 08-content-containers-tags type: concept title: Tags description: "Use the tag container to label versions, statuses, or highlight short text snippets inline." path: /08/content/containers/tags/ file: concepts/08-content-containers-tags.md locale: en version: 08 tags: - id: 08-content-frontmatter type: concept title: "Frontmatter Reference" description: "The complete guide to page-level metadata and configuration." path: /08/content/frontmatter/ file: concepts/08-content-frontmatter.md locale: en version: 08 tags: - id: 08-content-live-preview type: concept title: "Live Preview" description: "Run the engine entirely in the browser without a backend server using the Live architecture." path: /08/content/live-preview/ file: concepts/08-content-live-preview.md locale: en version: 08 tags: - id: 08-content-no-style-example type: concept title: "docmd : Bespoke No-Style Page Demo" description: "A functional demonstration of the noStyle architectural feature." path: /08/content/no-style-example/ file: concepts/08-content-no-style-example.md locale: en version: 08 tags: - id: 08-content-no-style-pages type: concept title: "No-Style Pages" description: "Create custom landing pages and unique layouts by disabling the default docmd theme." path: /08/content/no-style-pages/ file: concepts/08-content-no-style-pages.md locale: en version: 08 tags: - id: 08-content-syntax-advanced type: concept title: "Advanced Markdown Syntax" description: "Extended formatting features: task lists, custom element attributes, footnotes, and semantic definitions." path: /08/content/syntax/advanced/ file: concepts/08-content-syntax-advanced.md locale: en version: 08 tags: - id: 08-content-syntax-code type: concept title: "Code Blocks" description: "Document technical implementations with syntax highlighting, file titles, and one-click copying." path: /08/content/syntax/code/ file: concepts/08-content-syntax-code.md locale: en version: 08 tags: - id: 08-content-syntax-images type: concept title: "Images & Visual Media" description: "Embed responsive images, apply styling attributes, and enable interactive lightbox zoom." path: /08/content/syntax/images/ file: concepts/08-content-syntax-images.md locale: en version: 08 tags: - id: 08-content-syntax type: concept title: "Markdown Syntax Foundation" description: "The baseline formatting rules for all docmd content: typography, structure, lists, and tables." path: /08/content/syntax/ file: concepts/08-content-syntax.md locale: en version: 08 tags: - id: 08-content-syntax-linking type: concept title: "Linking & Referencing" description: "Master internal cross-linking, external resources, new-tab behaviour, and static asset referencing." path: /08/content/syntax/linking/ file: concepts/08-content-syntax-linking.md locale: en version: 08 tags: - id: 08-deployment-caddy type: concept title: Caddy description: "Deploy docmd with a production-ready Caddyfile." path: /08/deployment/caddy/ file: concepts/08-deployment-caddy.md locale: en version: 08 tags: - id: 08-deployment-cloudflare-pages type: concept title: "Cloudflare Pages" description: "Deploy your docmd documentation to Cloudflare Pages using its global edge network. CI/CD-ready with automatic builds." path: /08/deployment/cloudflare-pages/ file: concepts/08-deployment-cloudflare-pages.md locale: en version: 08 tags: - id: 08-deployment-deployer type: concept title: Deployer description: "Generate provider-specific deployment configuration files from your docmd project config with a single command." path: /08/deployment/deployer/ file: concepts/08-deployment-deployer.md locale: en version: 08 tags: - id: 08-deployment-docker type: concept title: Docker description: "Run docmd in a Docker container — use the official pre-built image or generate a custom Dockerfile from your project config." path: /08/deployment/docker/ file: concepts/08-deployment-docker.md locale: en version: 08 tags: - id: 08-deployment-firebase type: concept title: "Firebase Hosting" description: "Deploy your docmd documentation to Firebase Hosting. Works manually or via GitHub Actions." path: /08/deployment/firebase/ file: concepts/08-deployment-firebase.md locale: en version: 08 tags: - id: 08-deployment-github-action type: concept title: "GitHub Action" description: "Use the official docmd GitHub Action to build and deploy your documentation to GitHub Pages — zero config, one composable step." path: /08/deployment/github-action/ file: concepts/08-deployment-github-action.md locale: en version: 08 tags: - id: 08-deployment type: concept title: "Deployment Overview" description: "Choose how to deploy your docmd documentation site — from zero-config templates to self-hosted servers and cloud platforms." path: /08/deployment/ file: concepts/08-deployment.md locale: en version: 08 tags: - id: 08-deployment-netlify type: concept title: Netlify description: "Deploy your docmd documentation to Netlify using a generated netlify.toml." path: /08/deployment/netlify/ file: concepts/08-deployment-netlify.md locale: en version: 08 tags: - id: 08-deployment-nginx type: concept title: NGINX description: "Deploy docmd with a production-ready NGINX configuration." path: /08/deployment/nginx/ file: concepts/08-deployment-nginx.md locale: en version: 08 tags: - id: 08-deployment-starter-template type: concept title: "Starter Template" description: "Use the official docmd starter template to create a pre-configured documentation site with GitHub Pages deployment in under a minute." path: /08/deployment/starter-template/ file: concepts/08-deployment-starter-template.md locale: en version: 08 tags: - id: 08-deployment-vercel type: concept title: Vercel description: "Deploy your docmd documentation to Vercel using a generated vercel.json." path: /08/deployment/vercel/ file: concepts/08-deployment-vercel.md locale: en version: 08 tags: - id: 08-development-building-plugins type: concept title: "Building Plugins" description: "A comprehensive guide to extending docmd with custom logic, data injection, and interactive features." path: /08/development/building-plugins/ file: concepts/08-development-building-plugins.md locale: en version: 08 tags: - id: 08-development-building-templates type: concept title: "Building Templates" description: "Author a docmd template package — directory layout, descriptor, EJS context, asset priorities, and API reference." path: /08/development/building-templates/ file: concepts/08-development-building-templates.md locale: en version: 08 tags: - id: 08-development-engines-js type: concept title: "JavaScript Engine" description: "Deep explore docmd's native JavaScript execution engine: use cases, portability, capabilities, and limits." path: /08/development/engines/js/ file: concepts/08-development-engines-js.md locale: en version: 08 tags: - id: 08-development-engines-overview type: concept title: "Engines Overview" description: "Understand the pluggable build engine architecture and select the best processing backend." path: /08/development/engines/overview/ file: concepts/08-development-engines-overview.md locale: en version: 08 tags: - id: 08-development-engines-rust type: concept title: "Rust Engine" description: "Explore the optional native Rust engine: use cases, file I/O capabilities, supported packages, and limitations." path: /08/development/engines/rust/ file: concepts/08-development-engines-rust.md locale: en version: 08 tags: - id: 08-development-node-api-reference type: concept title: "Node API Reference" description: "Low-level Node API for plugin authors — URL utilities, action dispatchers, source tools, the engine loader, and TypeScript types." path: /08/development/node-api-reference/ file: concepts/08-development-node-api-reference.md locale: en version: 08 tags: - id: 08-development-plugin-examples type: concept title: "Extending docmd with Custom Plugins" description: "How to use docmd's lifecycle hooks to build custom functionality and extend the documentation engine." path: /08/development/plugin-examples/ file: concepts/08-development-plugin-examples.md locale: en version: 08 tags: - id: 08-development-setup type: concept title: Setup description: "Run this docs site locally, link to your global docmd install, and run the full verification pipeline." path: /08/development/setup/ file: concepts/08-development-setup.md locale: en version: 08 tags: - id: 08-getting-started-installation type: concept title: Installation description: "Install @docmd/core globally, locally within a project, or run containerised via the official Docker image. Requires Node.js 18+." path: /08/getting-started/installation/ file: concepts/08-getting-started-installation.md locale: en version: 08 tags: - id: 08-getting-started-project-structure type: concept title: "Project Structure" description: "Learn how `@docmd/core` maps physical folders and Markdown files to dynamic URLs and clean navigation." path: /08/getting-started/project-structure/ file: concepts/08-getting-started-project-structure.md locale: en version: 08 tags: - id: 08-getting-started-quick-start type: concept title: "Quick Start" description: "Go from an empty folder to a running documentation site in under a minute." path: /08/getting-started/quick-start/ file: concepts/08-getting-started-quick-start.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-context-preservation type: concept title: "Context Preservation for AI-Friendly Documentation" description: "How to ensure that AI models can understand and utilise the relationships between different parts of your documentation." path: /08/guides/ai-optimisation/context-preservation/ file: concepts/08-guides-ai-optimisation-context-preservation.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-deterministic-chunkable-docs type: concept title: "Creating Deterministic and Chunkable Documentation" description: "How to structure your documentation to optimise it for Retrieval-Augmented Generation (RAG) and AI ingestion." path: /08/guides/ai-optimisation/deterministic-chunkable-docs/ file: concepts/08-guides-ai-optimisation-deterministic-chunkable-docs.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-generating-ai-ready-docs type: concept title: "Generating AI-Ready Documentation with docmd" description: "How to use the llms.txt standard and docmd's built-in tools to provide optimised context for AI assistants." path: /08/guides/ai-optimisation/generating-ai-ready-docs/ file: concepts/08-guides-ai-optimisation-generating-ai-ready-docs.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-mcp-and-agent-skills type: concept title: "MCP & Agent Skills" description: "Optimise your documentation workspace for AI development agents using the Model Context Protocol and custom Skills." path: /08/guides/ai-optimisation/mcp-and-agent-skills/ file: concepts/08-guides-ai-optimisation-mcp-and-agent-skills.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-minimising-ai-hallucinations type: concept title: "Minimising AI Hallucinations via Documentation" description: "How to write explicit, self-contained documentation that prevents AI models from inventing incorrect information." path: /08/guides/ai-optimisation/minimising-ai-hallucinations/ file: concepts/08-guides-ai-optimisation-minimising-ai-hallucinations.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-okf-bundles type: concept title: "OKF Bundles — Deep Dive" description: "How to organise your docmd content for the best OKF bundle — typed concepts, cross-links, and the discipline that makes an AI-agent-friendly knowledge base." path: /08/guides/ai-optimisation/okf-bundles/ file: concepts/08-guides-ai-optimisation-okf-bundles.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-semantic-search-design type: concept title: "Designing for Semantic Search and RAG" description: "How to structure your documentation to optimise it for vector-based search and Retrieval-Augmented Generation." path: /08/guides/ai-optimisation/semantic-search-design/ file: concepts/08-guides-ai-optimisation-semantic-search-design.md locale: en version: 08 tags: - id: 08-guides-ai-optimisation-structure-for-llms type: concept title: "Structuring Documentation for AI Agents" description: "How to move from visual formatting to semantic structuring to improve the accuracy of AI coding assistants." path: /08/guides/ai-optimisation/structure-for-llms/ file: concepts/08-guides-ai-optimisation-structure-for-llms.md locale: en version: 08 tags: - id: 08-guides-integrations-alongside-other-tools type: concept title: "Alongside Other Tools" description: "Strategies for integrating docmd into a multi-tool documentation ecosystem to create a seamless user experience." path: /08/guides/integrations/alongside-other-tools/ file: concepts/08-guides-integrations-alongside-other-tools.md locale: en version: 08 tags: - id: 08-guides-integrations-choosing-deployment-method type: concept title: "Choosing Your Deployment Method" description: "A practical guide to choosing between the docmd GitHub App, GitHub Action, Starter Template, and Deployer Package — with a decision matrix and real-world scenarios." path: /08/guides/integrations/choosing-deployment-method/ file: concepts/08-guides-integrations-choosing-deployment-method.md locale: en version: 08 tags: - id: 08-guides-integrations-existing-markdown-repos type: concept title: "Existing Markdown Repos" description: "How to instantly generate a professional documentation site from your existing Markdown files with zero configuration." path: /08/guides/integrations/existing-markdown-repos/ file: concepts/08-guides-integrations-existing-markdown-repos.md locale: en version: 08 tags: - id: 08-guides-integrations-github-actions-cicd type: concept title: "GitHub Actions CI/CD" description: "How to automate your documentation builds and deployments using GitHub Actions and docmd for a high-velocity workflow." path: /08/guides/integrations/github-actions-cicd/ file: concepts/08-guides-integrations-github-actions-cicd.md locale: en version: 08 tags: - id: 08-guides-integrations-openapi-generation type: concept title: "OpenAPI Generation" description: "How to integrate OpenAPI/Swagger schemas into your docmd workflow for automated and synchronised API reference documentation." path: /08/guides/integrations/openapi-generation/ file: concepts/08-guides-integrations-openapi-generation.md locale: en version: 08 tags: - id: 08-guides-overview type: concept title: "Guides Overview" description: "Pick the right guide cluster for what you're trying to do — writing quality, workflows, search, performance, AI optimisation, or integrations." path: /08/guides/overview/ file: concepts/08-guides-overview.md locale: en version: 08 tags: - id: 08-guides-performance-delivery-caching-strategies type: concept title: "Caching Strategies" description: "How to optimise your documentation site's performance using immutable caching, Etag revalidation, and production-ready server configurations." path: /08/guides/performance-delivery/caching-strategies/ file: concepts/08-guides-performance-delivery-caching-strategies.md locale: en version: 08 tags: - id: 08-guides-performance-delivery-deploying-cdn-edge type: concept title: "CDN & Edge Deployment" description: "How to minimise global latency by deploying your static documentation to a Content Delivery Network (CDN) or Edge Network." path: /08/guides/performance-delivery/deploying-cdn-edge/ file: concepts/08-guides-performance-delivery-deploying-cdn-edge.md locale: en version: 08 tags: - id: 08-guides-performance-delivery-low-end-devices type: concept title: "Low-End Device Optimisation" description: "How to build high-performance, accessible documentation that works easily on low-powered hardware and slow network connections." path: /08/guides/performance-delivery/low-end-devices/ file: concepts/08-guides-performance-delivery-low-end-devices.md locale: en version: 08 tags: - id: 08-guides-performance-delivery-reducing-javascript-payload type: concept title: "Reducing JS Payload" description: "How to maintain a high-performance documentation site by optimising your JavaScript dependencies and using docmd's zero-framework architecture." path: /08/guides/performance-delivery/reducing-javascript-payload/ file: concepts/08-guides-performance-delivery-reducing-javascript-payload.md locale: en version: 08 tags: - id: 08-guides-performance-delivery-sub-100ms-navigation type: concept title: "Sub-100ms Navigation" description: "How docmd's native SPA router and intent-based prefetching deliver instant page transitions for an optimal reading experience." path: /08/guides/performance-delivery/sub-100ms-navigation/ file: concepts/08-guides-performance-delivery-sub-100ms-navigation.md locale: en version: 08 tags: - id: 08-guides-search-fast-accurate-search type: concept title: "Fast & Accurate Search" description: "How docmd optimises search indexing for speed and accuracy, even in large-scale documentation projects." path: /08/guides/search/fast-accurate-search/ file: concepts/08-guides-search-fast-accurate-search.md locale: en version: 08 tags: - id: 08-guides-search-improving-search-relevance type: concept title: "Search Relevance & Structure" description: "How to structure your Markdown content to improve search relevance and help users find information faster." path: /08/guides/search/improving-search-relevance/ file: concepts/08-guides-search-improving-search-relevance.md locale: en version: 08 tags: - id: 08-guides-search-local-first-search type: concept title: "Local-First Search Optimisation" description: "How to optimise your documentation content for docmd's high-performance, client-side search engine." path: /08/guides/search/local-first-search/ file: concepts/08-guides-search-local-first-search.md locale: en version: 08 tags: - id: 08-guides-search-semantic-search type: concept title: "Semantic Search Integration" description: "How to configure and deploy client-side hybrid semantic search in docmd using local vector embeddings." path: /08/guides/search/semantic-search/ file: concepts/08-guides-search-semantic-search.md locale: en version: 08 tags: - id: 08-guides-workflows-teams-git-based-workflows type: concept title: "Git-Based Workflows" description: "How to manage documentation contributions effectively using Git, Pull Requests, and automated CI/CD checks." path: /08/guides/workflows-teams/git-based-workflows/ file: concepts/08-guides-workflows-teams-git-based-workflows.md locale: en version: 08 tags: - id: 08-guides-workflows-teams-maintaining-consistency type: concept title: "Maintaining Consistency" description: "How to ensure a unified voice and professional quality across large documentation teams using linting and standardised patterns." path: /08/guides/workflows-teams/maintaining-consistency/ file: concepts/08-guides-workflows-teams-maintaining-consistency.md locale: en version: 08 tags: - id: 08-guides-workflows-teams-previewing-changes type: concept title: "Previewing Changes" description: "How to set up local and cloud-based preview environments to ensure your documentation renders perfectly before it goes live." path: /08/guides/workflows-teams/previewing-changes/ file: concepts/08-guides-workflows-teams-previewing-changes.md locale: en version: 08 tags: - id: 08-guides-workflows-teams-setting-up-workflow type: concept title: "Setting Up a Workflow" description: "How to establish a high-velocity, multi-author documentation workflow using docmd and docs-as-code principles." path: /08/guides/workflows-teams/setting-up-workflow/ file: concepts/08-guides-workflows-teams-setting-up-workflow.md locale: en version: 08 tags: - id: 08-guides-workflows-teams-versioning-release-workflows type: concept title: "Versioning Workflows" description: "How to synchronise documentation releases with software deployment using docmd's versioning engine and promotion strategies." path: /08/guides/workflows-teams/versioning-release-workflows/ file: concepts/08-guides-workflows-teams-versioning-release-workflows.md locale: en version: 08 tags: - id: 08-guides-writing-quality-avoiding-anti-patterns type: concept title: "Avoiding Anti-Patterns" description: "How to identify and eliminate common documentation mistakes that degrade the user experience and increase content debt." path: /08/guides/writing-quality/avoiding-anti-patterns/ file: concepts/08-guides-writing-quality-avoiding-anti-patterns.md locale: en version: 08 tags: - id: 08-guides-writing-quality-improving-readability type: concept title: "Improving Readability" description: "How to use visual rhythm, information hierarchy, and docmd's structural tools to create highly readable documentation." path: /08/guides/writing-quality/improving-readability/ file: concepts/08-guides-writing-quality-improving-readability.md locale: en version: 08 tags: - id: 08-guides-writing-quality-scalable-technical-writing type: concept title: "Scalable Technical Writing" description: "How to use Progressive Disclosure and structural containers to manage growing documentation complexity without overwhelming your users." path: /08/guides/writing-quality/scalable-technical-writing/ file: concepts/08-guides-writing-quality-scalable-technical-writing.md locale: en version: 08 tags: - id: 08-guides-writing-quality-task-vs-concept type: concept title: "Task vs. Concept" description: "How to apply the Diátaxis framework to separate 'How-To' guides from conceptual explanations for a more effective documentation structure." path: /08/guides/writing-quality/task-vs-concept/ file: concepts/08-guides-writing-quality-task-vs-concept.md locale: en version: 08 tags: - id: 08 type: concept title: "docmd docs: deploy production-ready docs from Markdown" description: "Build production-ready documentation from Markdown in seconds. Zero setup, fast by default, SEO-friendly, and AI-ready." path: /08/ file: concepts/08.md locale: en version: 08 tags: - id: 08-migration-docusaurus type: concept title: "Migrating from Docusaurus" description: "A comprehensive guide on moving your Docusaurus v2/v3 project to docmd." path: /08/migration/docusaurus/ file: concepts/08-migration-docusaurus.md locale: en version: 08 tags: - id: 08-migration-mkdocs type: concept title: "Migrating from MkDocs" description: "A comprehensive guide on moving your MkDocs (or Material for MkDocs) project to docmd." path: /08/migration/mkdocs/ file: concepts/08-migration-mkdocs.md locale: en version: 08 tags: - id: 08-migration-overview type: concept title: "Migration Overview" description: "Learn how to easily migrate your existing documentation to docmd." path: /08/migration/overview/ file: concepts/08-migration-overview.md locale: en version: 08 tags: - id: 08-migration-starlight type: concept title: "Migrating from Astro Starlight" description: "A comprehensive guide on moving your Astro Starlight project to docmd." path: /08/migration/starlight/ file: concepts/08-migration-starlight.md locale: en version: 08 tags: - id: 08-migration-vitepress type: concept title: "Migrating from VitePress" description: "A comprehensive guide on moving your VitePress project to docmd." path: /08/migration/vitepress/ file: concepts/08-migration-vitepress.md locale: en version: 08 tags: - id: 08-plugins-analytics type: concept title: "Analytics Plugin" description: "Integrate Google Analytics 4 or legacy Universal Analytics and track user interactions automatically." path: /08/plugins/analytics/ file: concepts/08-plugins-analytics.md locale: en version: 08 tags: - id: 08-plugins-git type: concept title: "Git Plugin" description: "Repository-aware metadata, last-updated timestamps, and automated edit links derived from Git history." path: /08/plugins/git/ file: concepts/08-plugins-git.md locale: en version: 08 tags: - id: 08-plugins-llms type: concept title: "LLM Context Plugin" description: "Optimise your documentation for AI consumption with automated llms.txt and llms-full.txt generation." path: /08/plugins/llms/ file: concepts/08-plugins-llms.md locale: en version: 08 tags: - id: 08-plugins-math type: concept title: "Math Plugin" description: "Native KaTeX/LaTeX mathematics integration for docmd." path: /08/plugins/math/ file: concepts/08-plugins-math.md locale: en version: 08 tags: - id: 08-plugins-mermaid type: concept title: "Mermaid Diagrams" description: "Create professional architectural diagrams, flowcharts, and sequence diagrams directly in your Markdown files using Mermaid.js syntax." path: /08/plugins/mermaid/ file: concepts/08-plugins-mermaid.md locale: en version: 08 tags: - id: 08-plugins-okf type: concept title: "OKF Bundle Plugin" description: "Generate an Open Knowledge Format (OKF) bundle from your docmd site so AI agents can consume your documentation directly." path: /08/plugins/okf/ file: concepts/08-plugins-okf.md locale: en version: 08 tags: - id: 08-plugins-openapi type: concept title: "OpenAPI Plugin" description: "Static API reference documentation rendered directly from OpenAPI 3.x specifications at build-time." path: /08/plugins/openapi/ file: concepts/08-plugins-openapi.md locale: en version: 08 tags: - id: 08-plugins-pwa type: concept title: "PWA & Offline Support" description: "Transform your documentation into a progressive web application with offline caching and mobile-first features." path: /08/plugins/pwa/ file: concepts/08-plugins-pwa.md locale: en version: 08 tags: - id: 08-plugins-search type: concept title: "Search Plugin" description: "Enable high-speed, offline-first full-text search for your documentation using MiniSearch." path: /08/plugins/search/ file: concepts/08-plugins-search.md locale: en version: 08 tags: - id: 08-plugins-seo type: concept title: "SEO Plugin" description: "Optimise your documentation for search engines and control AI crawler access with native meta tag generation." path: /08/plugins/seo/ file: concepts/08-plugins-seo.md locale: en version: 08 tags: - id: 08-plugins-sitemap type: concept title: "Sitemap Plugin" description: "Automatically generate a standard-compliant sitemap.xml for better search engine discovery." path: /08/plugins/sitemap/ file: concepts/08-plugins-sitemap.md locale: en version: 08 tags: - id: 08-plugins-threads type: concept title: "Threads Plugin" description: "Add inline discussion threads to your documentation - stored directly in your markdown files." path: /08/plugins/threads/ file: concepts/08-plugins-threads.md locale: en version: 08 tags: - id: 08-plugins-usage type: concept title: "Using Plugins" description: "Install, configure, and manage docmd plugins - from required defaults to optional add-ons." path: /08/plugins/usage/ file: concepts/08-plugins-usage.md locale: en version: 08 tags: - id: 08-reference-browser-api type: concept title: "Browser API (Client-Side)" description: "Interact with docmd from the browser - live compilation and dev-mode plugin communication." path: /08/reference/browser-api/ file: concepts/08-reference-browser-api.md locale: en version: 08 tags: - id: 08-reference-build-api type: concept title: "Build API" description: "Programmatic build API — call docmd from Node.js to build sites, live editor bundles, and workspace projects." path: /08/reference/build-api/ file: concepts/08-reference-build-api.md locale: en version: 08 tags: - id: 08-reference-cli-commands type: concept title: "CLI Commands" description: "Command-line reference for docmd - all available commands and options." path: /08/reference/cli-commands/ file: concepts/08-reference-cli-commands.md locale: en version: 08 tags: - id: 08-reference-client-side-events type: concept title: "Client-Side Events" description: "Hook into the docmd SPA lifecycle to add interactive features." path: /08/reference/client-side-events/ file: concepts/08-reference-client-side-events.md locale: en version: 08 tags: - id: 08-reference-live-api type: concept title: "Live Editor" description: "Understanding the docmd Live Editor and its browser-based authoring workflow." path: /08/reference/live-api/ file: concepts/08-reference-live-api.md locale: en version: 08 tags: - id: 08-reference-mcp-server type: concept title: "MCP Server" description: "Connect AI development agents to your documentation workspace using the Model Context Protocol." path: /08/reference/mcp-server/ file: concepts/08-reference-mcp-server.md locale: en version: 08 tags: - id: 08-release-notes-0-8-0 type: concept title: "docmd v0.8.0 - The Parallel Engine Era" description: "High-performance multi-threaded architecture, workspace support, and massive performance boosts." path: /08/release-notes/0-8-0/ file: concepts/08-release-notes-0-8-0.md locale: en version: 08 tags: - id: 08-release-notes-0-8-1 type: concept title: "docmd v0.8.1 - Engine Architecture & Git Cache Fixes" description: "Pluggable engine architecture (preview), persistent git indexing, navigation fixes, and JSON config standardisation." path: /08/release-notes/0-8-1/ file: concepts/08-release-notes-0-8-1.md locale: en version: 08 tags: - id: 08-release-notes-0-8-10 type: concept title: "v0.8.10 - CLI Polish and Workspace UX" description: "Release notes for docmd v0.8.10 - clearer CLI error messages, deploy and migrate flag coverage, and plugin installer accuracy." path: /08/release-notes/0-8-10/ file: concepts/08-release-notes-0-8-10.md locale: en version: 08 tags: - id: 08-release-notes-0-8-11 type: concept title: "v0.8.11 - Security Fixes and Cross-Locale Routing" description: "Release notes for docmd v0.8.11 - threads plugin XSS fix, init template JSON fix, cross-locale link rewrite, TUI error summary, Docusaurus frontmatter translation, and deploy template node bump." path: /08/release-notes/0-8-11/ file: concepts/08-release-notes-0-8-11.md locale: en version: 08 tags: - id: 08-release-notes-0-8-12 type: concept title: "v0.8.12 - Auto-Install Hardening and GitHub Pages Fix" description: "Release notes for docmd v0.8.12 - hardened auto-install pipeline (CWE-78), engine auto-install, corrected core dependency manifest, and automatic base path derivation for GitHub Pages project sites." path: /08/release-notes/0-8-12/ file: concepts/08-release-notes-0-8-12.md locale: en version: 08 tags: - id: 08-release-notes-0-8-13 type: concept title: "v0.8.13 - Centralised Base Tag and Auto-Install Cache Fix" description: "Release notes for docmd v0.8.13 - the tag is now enforced centrally by the generator (templates can no longer drift), offline mode no longer emits a tag (#177), and the auto-install retry path uses a manual node_modules walk-up that bypasses Node's stale require.resolve cache on Linux CI." path: /08/release-notes/0-8-13/ file: concepts/08-release-notes-0-8-13.md locale: en version: 08 tags: - id: 08-release-notes-0-8-14 type: concept title: "v0.8.14 - Offline Navigation Robustness, Secure Spawning, and Test Speed-up" description: "Release notes for docmd v0.8.14 - unified offline URL resolution (#179), path-traversal/command injection security hardening (#167, #175), and optimised test runner dependency resolution." path: /08/release-notes/0-8-14/ file: concepts/08-release-notes-0-8-14.md locale: en version: 08 tags: - id: 08-release-notes-0-8-15 type: concept title: "v0.8.15 - Subpath Deploy Fix, Local Search Bundle, and Auto-Install Cleanup" description: "Release notes for docmd v0.8.15 - proper GitHub Pages subpath asset resolution (#175), navigation trailing-slash consistency, locally-bundled MiniSearch, and de-duplicated auto-install output." path: /08/release-notes/0-8-15/ file: concepts/08-release-notes-0-8-15.md locale: en version: 08 tags: - id: 08-release-notes-0-8-16 type: concept title: "v0.8.16 - Dev Server Base Fix, Unified Search Folder, and Auto-Install Hardening" description: "Release notes for docmd v0.8.16 - dev server no longer breaks on subpath URLs, all search artefacts move to .docmd-search/, the redundant manifest probe is removed, and auto-install no longer pre-blocks workspace sub-projects." path: /08/release-notes/0-8-16/ file: concepts/08-release-notes-0-8-16.md locale: en version: 08 tags: - id: 08-release-notes-0-8-17 type: concept title: "v0.8.17 - Page-Relative Navigation, Local Dev Switcher Fixes, and --offline Build Support" description: "Release notes for docmd v0.8.17 - switchers and menubar adopt page-relative links, language/version switchers dynamically normalize base paths at runtime, SPA transitions sync menubar and banners, and --offline flag skips indexing to speed up builds." path: /08/release-notes/0-8-17/ file: concepts/08-release-notes-0-8-17.md locale: en version: 08 tags: - id: 08-release-notes-0-8-2 type: concept title: "docmd v0.8.2 - Patch Release" description: "Patched dependency protocol errors and updated release automation." path: /08/release-notes/0-8-2/ file: concepts/08-release-notes-0-8-2.md locale: en version: 08 tags: - id: 08-release-notes-0-8-3 type: concept title: "docmd v0.8.3 - Workspaces & Enhanced Security" description: "Introduced the new Workspace architecture with configuration cascading, a premium Project Switcher, and major security hardening." path: /08/release-notes/0-8-3/ file: concepts/08-release-notes-0-8-3.md locale: en version: 08 tags: - id: 08-release-notes-0-8-4 type: concept title: "v0.8.4 - Deployer & Security" description: "Release notes for docmd v0.8.4 - modular deployer package, markdown line break control, security hardening, and stability fixes." path: /08/release-notes/0-8-4/ file: concepts/08-release-notes-0-8-4.md locale: en version: 08 tags: - id: 08-release-notes-0-8-5 type: concept title: "v0.8.5 - Semantic Search Alpha & SEO Enhancements" description: "Release notes for docmd v0.8.5 - semantic search alpha preview, SEO plugin robots.txt auto-generation, Mermaid C4Context fix, and config upgrade CLI." path: /08/release-notes/0-8-5/ file: concepts/08-release-notes-0-8-5.md locale: en version: 08 tags: - id: 08-release-notes-0-8-6 type: concept title: "v0.8.6 - AI-First Integration, MCP & Docker" description: "Release notes for docmd v0.8.6 - native MCP Server, modular Agent Skills, official Docker image, CJK search tokenization, Copy Context widgets, and TOC improvements." path: /08/release-notes/0-8-6/ file: concepts/08-release-notes-0-8-6.md locale: en version: 08 tags: - id: 08-release-notes-0-8-7 type: concept title: "v0.8.7 - Custom Template Plugin API" description: "Release notes for docmd v0.8.7 - the new Custom Template Plugin API with Summer template preview, opt-in cookie consent dialog, site-wide announcement banner, asset priority system, and 0.8.6 Docker :latest tag fix." path: /08/release-notes/0-8-7/ file: concepts/08-release-notes-0-8-7.md locale: en version: 08 tags: - id: 08-release-notes-0-8-8 type: concept title: "v0.8.8 - Hardening Release" description: "Release notes for docmd v0.8.8 - fixes for Docker volume permissions, plugin auto-install on npx, template registry lookup, UI translation keys, --offline navigation, and CI workflow correctness." path: /08/release-notes/0-8-8/ file: concepts/08-release-notes-0-8-8.md locale: en version: 08 tags: - id: 08-release-notes-0-8-9 type: concept title: "v0.8.9 - Plugin Loader Hardening" description: "Release notes for docmd v0.8.9 - build-time plugin registry, docmd namespace, docmd doctor, and silent tarball fixes." path: /08/release-notes/0-8-9/ file: concepts/08-release-notes-0-8-9.md locale: en version: 08 tags: - id: 08-theming-assets-management type: concept title: "Assets Management" description: "How docmd handles CSS, JavaScript, and Image assets during the build process." path: /08/theming/assets-management/ file: concepts/08-theming-assets-management.md locale: en version: 08 tags: - id: 08-theming-available-themes type: concept title: "Available Themes" description: "Explore docmd's built-in themes including Sky, Ruby, and Retro. Learn how to switch themes with a single config line." path: /08/theming/available-themes/ file: concepts/08-theming-available-themes.md locale: en version: 08 tags: - id: 08-theming-custom-css-js type: concept title: "Custom Styles & Scripts" description: "Inject your own CSS and JS files to extend docmd's functionality and branding." path: /08/theming/custom-css-js/ file: concepts/08-theming-custom-css-js.md locale: en version: 08 tags: - id: 08-theming-customisation type: concept title: "Customisation & Variables" description: "A complete reference of docmd's CSS variables and component classes for advanced styling." path: /08/theming/customisation/ file: concepts/08-theming-customisation.md locale: en version: 08 tags: - id: 08-theming-favicons-metadata type: concept title: "Customising Favicons and Metadata" description: "How to configure your site's visual identity in the browser and optimise social media previews." path: /08/theming/favicons-metadata/ file: concepts/08-theming-favicons-metadata.md locale: en version: 08 tags: - id: 08-theming-fonts-branding type: concept title: "Custom Fonts and Branding" description: "How to match your documentation's appearance to your corporate identity using CSS variables." path: /08/theming/fonts-branding/ file: concepts/08-theming-fonts-branding.md locale: en version: 08 tags: - id: 08-theming-icons type: concept title: Icons description: "How to use and customise Lucide icons in your documentation." path: /08/theming/icons/ file: concepts/08-theming-icons.md locale: en version: 08 tags: - id: 08-theming-landing-pages type: concept title: "Designing Custom Landing Pages" description: "How to use docmd's hero and grid containers to create premium landing pages for your documentation." path: /08/theming/landing-pages/ file: concepts/08-theming-landing-pages.md locale: en version: 08 tags: - id: 08-theming-light-dark-mode type: concept title: "Light & Dark Mode" description: "How to configure the default viewing mode and manage the theme switcher for the best user experience." path: /08/theming/light-dark-mode/ file: concepts/08-theming-light-dark-mode.md locale: en version: 08 tags: - id: 08-theming-templates type: concept title: Templates description: "Install alternative site layouts from npm packages. Each template layers a complete HTML/CSS/JS bundle on top of the default theme." path: /08/theming/templates/ file: concepts/08-theming-templates.md locale: en version: 08 tags: - id: 07-api-browser-api type: concept title: "Browser API (Client-Side)" description: "Interact with docmd from the browser - live compilation and dev-mode plugin communication." path: /07/api/browser-api/ file: concepts/07-api-browser-api.md locale: en version: 07 tags: - id: 07-api-cli-commands type: concept title: "CLI Commands" description: "Command-line reference for docmd - all available commands and options." path: /07/api/cli-commands/ file: concepts/07-api-cli-commands.md locale: en version: 07 tags: - id: 07-api-client-side-events type: concept title: "Client-Side Events" description: "Hook into the docmd SPA lifecycle to add interactive features." path: /07/api/client-side-events/ file: concepts/07-api-client-side-events.md locale: en version: 07 tags: - id: 07-api-live-api type: concept title: "Live Editor" description: "Understanding the docmd Live Editor and its browser-based authoring workflow." path: /07/api/live-api/ file: concepts/07-api-live-api.md locale: en version: 07 tags: - id: 07-api-node-api type: concept title: "Node.js API" description: "Integrate docmd's build engine into your custom Node.js scripts and automation pipelines." path: /07/api/node-api/ file: concepts/07-api-node-api.md locale: en version: 07 tags: - id: 07-comparison type: concept title: Comparison description: "How docmd stacks up against Docusaurus, VitePress, MkDocs, Starlight, and Mintlify - real numbers, real features." path: /07/comparison/ file: concepts/07-comparison.md locale: en version: 07 tags: - id: 07-configuration-layout-ui type: concept title: "Layout & UI Zones" description: "Control the interface structure by managing headers, sidebars, and functional UI slots." path: /07/configuration/layout-ui/ file: concepts/07-configuration-layout-ui.md locale: en version: 07 tags: - id: 07-configuration-localisation type: concept title: Localisation description: "Serve documentation in multiple languages with locale-first routing, translated navigation, and automatic fallback." path: /07/configuration/localisation/ file: concepts/07-configuration-localisation.md locale: en version: 07 tags: - id: 07-configuration-localisation-translated-content type: concept title: "Translated Content" description: "Organise translations in locale subdirectories with per-file fallback and per-locale navigation." path: /07/configuration/localisation/translated-content/ file: concepts/07-configuration-localisation-translated-content.md locale: en version: 07 tags: - id: 07-configuration-localisation-ui-strings type: concept title: "UI Strings & SEO" description: "Customise system UI text per locale and understand automatic SEO tags for multi-language sites." path: /07/configuration/localisation/ui-strings/ file: concepts/07-configuration-localisation-ui-strings.md locale: en version: 07 tags: - id: 07-configuration-menubar type: concept title: Menubar description: "Structure and position your menubar, manage navigation links, and configure drop-down menus." path: /07/configuration/menubar/ file: concepts/07-configuration-menubar.md locale: en version: 07 tags: - id: 07-configuration-multi-project type: concept title: "Multi-Project Configuration" description: "Build multiple independent documentation sites from a single docmd instance. Shared assets, independent versioning, one deployment." path: /07/configuration/multi-project/ file: concepts/07-configuration-multi-project.md locale: en version: 07 tags: - id: 07-configuration-navigation type: concept title: "Navigation Configuration" description: "Structure your sidebar, categorise links, and assign icons for human readers and LLMs." path: /07/configuration/navigation/ file: concepts/07-configuration-navigation.md locale: en version: 07 tags: - id: 07-configuration-overview type: concept title: "General Configuration" description: "Configure docmd.config.js schema, branding, layout, and engine features." path: /07/configuration/overview/ file: concepts/07-configuration-overview.md locale: en version: 07 tags: - id: 07-configuration-redirects type: concept title: "Redirects & 404" description: "Configure metadata-based redirects and custom branded 404 error pages for static deployments." path: /07/configuration/redirects/ file: concepts/07-configuration-redirects.md locale: en version: 07 tags: - id: 07-configuration-versioning type: concept title: Versioning description: "Enable multi-version documentation with seamless switching, sticky path preservation, and isolated build directories." path: /07/configuration/versioning/ file: concepts/07-configuration-versioning.md locale: en version: 07 tags: - id: 07-content-containers-buttons type: concept title: Buttons description: "Inject call-to-action buttons for internal routing or external resources with a single-line syntax." path: /07/content/containers/buttons/ file: concepts/07-content-containers-buttons.md locale: en version: 07 tags: - id: 07-content-containers-callouts type: concept title: Callouts description: "Highlight critical warnings, pro-tips, and background context using semantic visual blocks." path: /07/content/containers/callouts/ file: concepts/07-content-containers-callouts.md locale: en version: 07 tags: - id: 07-content-containers-cards type: concept title: Untitled description: "" path: /07/content/containers/cards/ file: concepts/07-content-containers-cards.md locale: en version: 07 tags: - id: 07-content-containers-changelogs type: concept title: Changelogs description: "Generate structured, timeline-based version history and release notes." path: /07/content/containers/changelogs/ file: concepts/07-content-containers-changelogs.md locale: en version: 07 tags: - id: 07-content-containers-collapsible type: concept title: "Collapsible Sections" description: "Embed interactive accordion-style toggles for FAQs, deep-dive content, and spoilers." path: /07/content/containers/collapsible/ file: concepts/07-content-containers-collapsible.md locale: en version: 07 tags: - id: 07-content-containers-embed type: concept title: "URL Embeds" description: "How to safely embed dynamic components, videos, and social media directly into your documents." path: /07/content/containers/embed/ file: concepts/07-content-containers-embed.md locale: en version: 07 tags: - id: 07-content-containers-grids type: concept title: Grids description: "Organise layout easily with auto-adjusting responsive columns using native markdown containers." path: /07/content/containers/grids/ file: concepts/07-content-containers-grids.md locale: en version: 07 tags: - id: 07-content-containers-hero type: concept title: "Hero Sections" description: "Build high-impact landing page headers and marketing highlights purely in Markdown." path: /07/content/containers/hero/ file: concepts/07-content-containers-hero.md locale: en version: 07 tags: - id: 07-content-containers type: concept title: "Custom Interactive Containers" description: "A comprehensive directory of the interactive UI building blocks available in docmd." path: /07/content/containers/ file: concepts/07-content-containers.md locale: en version: 07 tags: - id: 07-content-containers-nested-containers type: concept title: "Nested Containers" description: "Use docmd's recursive parser to combine cards, tabs, and callouts into high-fidelity page layouts." path: /07/content/containers/nested-containers/ file: concepts/07-content-containers-nested-containers.md locale: en version: 07 tags: - id: 07-content-containers-steps type: concept title: Steps description: "Convert standard ordered lists into high-impact visual timelines and tutorials." path: /07/content/containers/steps/ file: concepts/07-content-containers-steps.md locale: en version: 07 tags: - id: 07-content-containers-tabs type: concept title: Tabs description: "Organise dense, alternative, or multi-language information into switchable interactive panes." path: /07/content/containers/tabs/ file: concepts/07-content-containers-tabs.md locale: en version: 07 tags: - id: 07-content-containers-tags type: concept title: Tags description: "Use the tag container to label versions, statuses, or highlight short text snippets easily inline." path: /07/content/containers/tags/ file: concepts/07-content-containers-tags.md locale: en version: 07 tags: - id: 07-content-frontmatter type: concept title: "Frontmatter Reference" description: "The complete guide to page-level metadata and configuration in docmd." path: /07/content/frontmatter/ file: concepts/07-content-frontmatter.md locale: en version: 07 tags: - id: 07-content-live-preview type: concept title: "Live Preview" description: "Run docmd entirely in the browser without a backend server using the Live architecture." path: /07/content/live-preview/ file: concepts/07-content-live-preview.md locale: en version: 07 tags: - id: 07-content-no-style-example type: concept title: "docmd : Bespoke No-Style Page Demo" description: "A functional demonstration of the noStyle architectural feature." path: /07/content/no-style-example/ file: concepts/07-content-no-style-example.md locale: en version: 07 tags: - id: 07-content-no-style-pages type: concept title: "No-Style Pages" description: "Create custom landing pages and unique layouts by disabling the default docmd theme." path: /07/content/no-style-pages/ file: concepts/07-content-no-style-pages.md locale: en version: 07 tags: - id: 07-content-syntax-advanced type: concept title: "Advanced Markdown Syntax" description: "Use docmd's extended feature set: Custom attributes, GFM extensions, and semantic definitions." path: /07/content/syntax/advanced/ file: concepts/07-content-syntax-advanced.md locale: en version: 07 tags: - id: 07-content-syntax-code type: concept title: "Code Blocks" description: "Document technical implementations with high-fidelity syntax highlighting and interactive copy buttons." path: /07/content/syntax/code/ file: concepts/07-content-syntax-code.md locale: en version: 07 tags: - id: 07-content-syntax-images type: concept title: "Images & Visual Media" description: "Master media management: Responsive images, styling attributes, and automated Lightbox effects." path: /07/content/syntax/images/ file: concepts/07-content-syntax-images.md locale: en version: 07 tags: - id: 07-content-syntax type: concept title: "Markdown Syntax Foundation" description: "Master the fundamental formatting rules of docmd: Headings, typographic styles, and technical blocks." path: /07/content/syntax/ file: concepts/07-content-syntax.md locale: en version: 07 tags: - id: 07-content-syntax-linking type: concept title: "Linking & Referencing" description: "Master internal cross-linking, external resources, and reliable asset referencing with docmd's automatic URL normalisation." path: /07/content/syntax/linking/ file: concepts/07-content-syntax-linking.md locale: en version: 07 tags: - id: 07-contributing type: concept title: Contributing description: "Guidelines and setup instructions for contributing to docmd." path: /07/contributing/ file: concepts/07-contributing.md locale: en version: 07 tags: - id: 07-deployment-caddy type: concept title: Caddy description: "Deploy docmd with a production-ready Caddyfile." path: /07/deployment/caddy/ file: concepts/07-deployment-caddy.md locale: en version: 07 tags: - id: 07-deployment-ci-cd type: concept title: "CI/CD Pipelines" description: "Automate documentation builds and deployments with CI/CD pipelines for GitHub Pages, Vercel, Netlify, and more." path: /07/deployment/ci-cd/ file: concepts/07-deployment-ci-cd.md locale: en version: 07 tags: - id: 07-deployment-docker type: concept title: Docker description: "Deploy docmd in a Docker container with a single command." path: /07/deployment/docker/ file: concepts/07-deployment-docker.md locale: en version: 07 tags: - id: 07-deployment type: concept title: Deployment description: "Deploy your docmd documentation to Docker, Nginx, Caddy, or any cloud platform with a single command." path: /07/deployment/ file: concepts/07-deployment.md locale: en version: 07 tags: - id: 07-deployment-nginx type: concept title: NGINX description: "Deploy docmd with a production-ready NGINX configuration." path: /07/deployment/nginx/ file: concepts/07-deployment-nginx.md locale: en version: 07 tags: - id: 07-getting-started-installation type: concept title: Installation description: "Install docmd globally, locally, or run it instantly with npx. Requires Node.js 18+." path: /07/getting-started/installation/ file: concepts/07-getting-started-installation.md locale: en version: 07 tags: - id: 07-getting-started-project-structure type: concept title: "Project Structure" description: "Learn how docmd maps physical folders and Markdown files to dynamic URLs and clean navigation." path: /07/getting-started/project-structure/ file: concepts/07-getting-started-project-structure.md locale: en version: 07 tags: - id: 07-getting-started-quick-start type: concept title: "Quick Start" description: "Go from an empty folder to a running documentation site in under a minute." path: /07/getting-started/quick-start/ file: concepts/07-getting-started-quick-start.md locale: en version: 07 tags: - id: 07-guides-ai-optimisation-context-preservation type: concept title: "Context Preservation for AI-Friendly Documentation" description: "How to ensure that AI models can understand and utilise the relationships between different parts of your documentation." path: /07/guides/ai-optimisation/context-preservation/ file: concepts/07-guides-ai-optimisation-context-preservation.md locale: en version: 07 tags: - id: 07-guides-ai-optimisation-deterministic-chunkable-docs type: concept title: "Creating Deterministic and Chunkable Documentation" description: "How to structure your documentation to optimise it for Retrieval-Augmented Generation (RAG) and AI ingestion." path: /07/guides/ai-optimisation/deterministic-chunkable-docs/ file: concepts/07-guides-ai-optimisation-deterministic-chunkable-docs.md locale: en version: 07 tags: - id: 07-guides-ai-optimisation-generating-ai-ready-docs type: concept title: "Generating AI-Ready Documentation with docmd" description: "How to use the llms.txt standard and docmd's built-in tools to provide optimised context for AI assistants." path: /07/guides/ai-optimisation/generating-ai-ready-docs/ file: concepts/07-guides-ai-optimisation-generating-ai-ready-docs.md locale: en version: 07 tags: - id: 07-guides-ai-optimisation-minimising-ai-hallucinations type: concept title: "Minimising AI Hallucinations via Documentation" description: "How to write explicit, self-contained documentation that prevents AI models from inventing incorrect information." path: /07/guides/ai-optimisation/minimising-ai-hallucinations/ file: concepts/07-guides-ai-optimisation-minimising-ai-hallucinations.md locale: en version: 07 tags: - id: 07-guides-ai-optimisation-semantic-search-design type: concept title: "Designing for Semantic Search and RAG" description: "How to structure your documentation to optimise it for vector-based search and Retrieval-Augmented Generation." path: /07/guides/ai-optimisation/semantic-search-design/ file: concepts/07-guides-ai-optimisation-semantic-search-design.md locale: en version: 07 tags: - id: 07-guides-ai-optimisation-structure-for-llms type: concept title: "Structuring Documentation for AI Agents" description: "How to move from visual formatting to semantic structuring to improve the accuracy of AI coding assistants." path: /07/guides/ai-optimisation/structure-for-llms/ file: concepts/07-guides-ai-optimisation-structure-for-llms.md locale: en version: 07 tags: - id: 07-guides-content-ux-avoiding-anti-patterns type: concept title: "Avoiding Anti-Patterns" description: "How to identify and eliminate common documentation mistakes that degrade the user experience and increase content debt." path: /07/guides/content-ux/avoiding-anti-patterns/ file: concepts/07-guides-content-ux-avoiding-anti-patterns.md locale: en version: 07 tags: - id: 07-guides-content-ux-improving-readability type: concept title: "Improving Readability" description: "How to use visual rhythm, information hierarchy, and docmd's structural tools to create highly readable documentation." path: /07/guides/content-ux/improving-readability/ file: concepts/07-guides-content-ux-improving-readability.md locale: en version: 07 tags: - id: 07-guides-content-ux-navigation-large-sites type: concept title: "Navigation for Large Sites" description: "How to organise complex documentation sets into an intuitive, scalable navigation structure using docmd's layout tools." path: /07/guides/content-ux/navigation-large-sites/ file: concepts/07-guides-content-ux-navigation-large-sites.md locale: en version: 07 tags: - id: 07-guides-content-ux-scalable-technical-writing type: concept title: "Scalable Technical Writing" description: "How to use Progressive Disclosure and structural containers to manage growing documentation complexity without overwhelming your users." path: /07/guides/content-ux/scalable-technical-writing/ file: concepts/07-guides-content-ux-scalable-technical-writing.md locale: en version: 07 tags: - id: 07-guides-content-ux-task-vs-concept type: concept title: "Task vs. Concept" description: "How to apply the Diátaxis framework to separate 'How-To' guides from conceptual explanations for a more effective documentation structure." path: /07/guides/content-ux/task-vs-concept/ file: concepts/07-guides-content-ux-task-vs-concept.md locale: en version: 07 tags: - id: 07-guides-customisation-custom-favicons-metadata type: concept title: "Customising Favicons and Metadata" description: "How to configure your site's visual identity in the browser and optimise social media previews." path: /07/guides/customisation/custom-favicons-metadata/ file: concepts/07-guides-customisation-custom-favicons-metadata.md locale: en version: 07 tags: - id: 07-guides-customisation-custom-fonts-branding type: concept title: "Custom Fonts and Branding" description: "How to match your documentation's appearance to your corporate identity using CSS variables." path: /07/guides/customisation/custom-fonts-branding/ file: concepts/07-guides-customisation-custom-fonts-branding.md locale: en version: 07 tags: - id: 07-guides-customisation-custom-landing-pages type: concept title: "Designing Custom Landing Pages" description: "How to use docmd's hero and grid containers to create premium landing pages for your documentation." path: /07/guides/customisation/custom-landing-pages/ file: concepts/07-guides-customisation-custom-landing-pages.md locale: en version: 07 tags: - id: 07-guides-customisation-extending-custom-plugins type: concept title: "Extending docmd with Custom Plugins" description: "How to use docmd's lifecycle hooks to build custom functionality and extend the documentation engine." path: /07/guides/customisation/extending-custom-plugins/ file: concepts/07-guides-customisation-extending-custom-plugins.md locale: en version: 07 tags: - id: 07-guides-integrations-alongside-other-tools type: concept title: "Alongside Other Tools" description: "Strategies for integrating docmd into a multi-tool documentation ecosystem to create a seamless user experience." path: /07/guides/integrations/alongside-other-tools/ file: concepts/07-guides-integrations-alongside-other-tools.md locale: en version: 07 tags: - id: 07-guides-integrations-existing-markdown-repos type: concept title: "Existing Markdown Repos" description: "How to instantly generate a professional documentation site from your existing Markdown files with zero configuration." path: /07/guides/integrations/existing-markdown-repos/ file: concepts/07-guides-integrations-existing-markdown-repos.md locale: en version: 07 tags: - id: 07-guides-integrations-github-actions-cicd type: concept title: "GitHub Actions CI/CD" description: "How to automate your documentation builds and deployments using GitHub Actions and docmd for a high-velocity documentation workflow." path: /07/guides/integrations/github-actions-cicd/ file: concepts/07-guides-integrations-github-actions-cicd.md locale: en version: 07 tags: - id: 07-guides-integrations-openapi-generation type: concept title: "OpenAPI Generation" description: "How to integrate OpenAPI/Swagger schemas into your docmd workflow for automated and synchronised API reference documentation." path: /07/guides/integrations/openapi-generation/ file: concepts/07-guides-integrations-openapi-generation.md locale: en version: 07 tags: - id: 07-guides-performance-delivery-caching-strategies type: concept title: "Caching Strategies" description: "How to optimise your documentation site's performance using immutable caching, Etag revalidation, and production-ready server configurations." path: /07/guides/performance-delivery/caching-strategies/ file: concepts/07-guides-performance-delivery-caching-strategies.md locale: en version: 07 tags: - id: 07-guides-performance-delivery-deploying-cdn-edge type: concept title: "CDN & Edge Deployment" description: "How to minimise global latency by deploying your static documentation to a Content Delivery Network (CDN) or Edge Network." path: /07/guides/performance-delivery/deploying-cdn-edge/ file: concepts/07-guides-performance-delivery-deploying-cdn-edge.md locale: en version: 07 tags: - id: 07-guides-performance-delivery-low-end-devices type: concept title: "Low-End Device Optimisation" description: "How to build high-performance, accessible documentation that works easily on low-powered hardware and slow network connections." path: /07/guides/performance-delivery/low-end-devices/ file: concepts/07-guides-performance-delivery-low-end-devices.md locale: en version: 07 tags: - id: 07-guides-performance-delivery-reducing-javascript-payload type: concept title: "Reducing JS Payload" description: "How to maintain a high-performance documentation site by optimising your JavaScript dependencies and using docmd's zero-framework architecture." path: /07/guides/performance-delivery/reducing-javascript-payload/ file: concepts/07-guides-performance-delivery-reducing-javascript-payload.md locale: en version: 07 tags: - id: 07-guides-performance-delivery-sub-100ms-navigation type: concept title: "Sub-100ms Navigation" description: "How docmd's native SPA router and intent-based prefetching deliver instant page transitions for an optimal reading experience." path: /07/guides/performance-delivery/sub-100ms-navigation/ file: concepts/07-guides-performance-delivery-sub-100ms-navigation.md locale: en version: 07 tags: - id: 07-guides-scaling-architecture-breaking-changes-deprecations type: concept title: "Breaking Changes & Deprecations" description: "How to communicate API changes and migration paths effectively using versioned documentation and contextual callouts." path: /07/guides/scaling-architecture/breaking-changes-deprecations/ file: concepts/07-guides-scaling-architecture-breaking-changes-deprecations.md locale: en version: 07 tags: - id: 07-guides-scaling-architecture-multi-team-collaboration type: concept title: "Multi-Team Collaboration" description: "How to use decentralized navigation and global menubars to allow multiple teams to contribute to a unified documentation project without friction." path: /07/guides/scaling-architecture/multi-team-collaboration/ file: concepts/07-guides-scaling-architecture-multi-team-collaboration.md locale: en version: 07 tags: - id: 07-guides-scaling-architecture-multi-version-documentation type: concept title: "Managing Multi-Version Documentation" description: "How to maintain multiple versions of your documentation (v1, v2, legacy) with a unified switcher and path preservation." path: /07/guides/scaling-architecture/multi-version-documentation/ file: concepts/07-guides-scaling-architecture-multi-version-documentation.md locale: en version: 07 tags: - id: 07-guides-scaling-architecture-organising-large-repositories type: concept title: "Organising Large Repositories" description: "How to maintain navigation clarity and usability in complex documentation structures using hub pages and hierarchical navigation." path: /07/guides/scaling-architecture/organising-large-repositories/ file: concepts/07-guides-scaling-architecture-organising-large-repositories.md locale: en version: 07 tags: - id: 07-guides-scaling-architecture-scalable-folder-structure type: concept title: "Scalable Folder Structure" description: "How to organise large-scale documentation projects using the Diátaxis framework and docmd's resolution system." path: /07/guides/scaling-architecture/scalable-folder-structure/ file: concepts/07-guides-scaling-architecture-scalable-folder-structure.md locale: en version: 07 tags: - id: 07-guides-scaling-architecture-scaling type: concept title: "Scaling to 1000+ Pages" description: "How to maintain high performance and usability in massive documentation projects with docmd." path: /07/guides/scaling-architecture/scaling/ file: concepts/07-guides-scaling-architecture-scaling.md locale: en version: 07 tags: - id: 07-guides-search-fast-accurate-search type: concept title: "Fast & Accurate Search" description: "How docmd optimises search indexing for speed and accuracy, even in large-scale documentation projects." path: /07/guides/search/fast-accurate-search/ file: concepts/07-guides-search-fast-accurate-search.md locale: en version: 07 tags: - id: 07-guides-search-improving-search-relevance type: concept title: "Search Relevance & Structure" description: "How to structure your Markdown content to improve search relevance and help users find information faster." path: /07/guides/search/improving-search-relevance/ file: concepts/07-guides-search-improving-search-relevance.md locale: en version: 07 tags: - id: 07-guides-search-local-first-search type: concept title: "Local-First Search Optimisation" description: "How to optimise your documentation content for docmd's high-performance, client-side search engine." path: /07/guides/search/local-first-search/ file: concepts/07-guides-search-local-first-search.md locale: en version: 07 tags: - id: 07-guides-workflows-teams-git-based-workflows type: concept title: "Git-Based Workflows" description: "How to manage documentation contributions effectively using Git, Pull Requests, and automated CI/CD checks." path: /07/guides/workflows-teams/git-based-workflows/ file: concepts/07-guides-workflows-teams-git-based-workflows.md locale: en version: 07 tags: - id: 07-guides-workflows-teams-maintaining-consistency type: concept title: "Maintaining Consistency" description: "How to ensure a unified voice and professional quality across large documentation teams using linting and standardised patterns." path: /07/guides/workflows-teams/maintaining-consistency/ file: concepts/07-guides-workflows-teams-maintaining-consistency.md locale: en version: 07 tags: - id: 07-guides-workflows-teams-previewing-changes type: concept title: "Previewing Changes" description: "How to set up local and cloud-based preview environments to ensure your documentation renders perfectly before it goes live." path: /07/guides/workflows-teams/previewing-changes/ file: concepts/07-guides-workflows-teams-previewing-changes.md locale: en version: 07 tags: - id: 07-guides-workflows-teams-setting-up-workflow type: concept title: "Setting Up a Workflow" description: "How to establish a high-velocity, multi-author documentation workflow using docmd and docs-as-code principles." path: /07/guides/workflows-teams/setting-up-workflow/ file: concepts/07-guides-workflows-teams-setting-up-workflow.md locale: en version: 07 tags: - id: 07-guides-workflows-teams-versioning-release-workflows type: concept title: "Versioning Workflows" description: "How to synchronise documentation releases with software deployment using docmd's versioning engine and promotion strategies." path: /07/guides/workflows-teams/versioning-release-workflows/ file: concepts/07-guides-workflows-teams-versioning-release-workflows.md locale: en version: 07 tags: - id: 07 type: concept title: "docmd docs: deploy production-ready docs from Markdown" description: "Build production-ready documentation from Markdown in seconds. Zero setup, fast by default, SEO-friendly, and AI-ready." path: /07/ file: concepts/07.md locale: en version: 07 tags: - id: 07-migration-docusaurus type: concept title: "Migrating from Docusaurus" description: "A comprehensive guide on moving your Docusaurus v2/v3 project to docmd." path: /07/migration/docusaurus/ file: concepts/07-migration-docusaurus.md locale: en version: 07 tags: - id: 07-migration-mkdocs type: concept title: "Migrating from MkDocs" description: "A comprehensive guide on moving your MkDocs (or Material for MkDocs) project to docmd." path: /07/migration/mkdocs/ file: concepts/07-migration-mkdocs.md locale: en version: 07 tags: - id: 07-migration-overview type: concept title: "Migration Overview" description: "Learn how to easily migrate your existing documentation to docmd." path: /07/migration/overview/ file: concepts/07-migration-overview.md locale: en version: 07 tags: - id: 07-migration-starlight type: concept title: "Migrating from Astro Starlight" description: "A comprehensive guide on moving your Astro Starlight project to docmd." path: /07/migration/starlight/ file: concepts/07-migration-starlight.md locale: en version: 07 tags: - id: 07-migration-vitepress type: concept title: "Migrating from VitePress" description: "A comprehensive guide on moving your VitePress project to docmd." path: /07/migration/vitepress/ file: concepts/07-migration-vitepress.md locale: en version: 07 tags: - id: 07-plugins-analytics type: concept title: "Analytics Plugin" description: "Integrate Google Analytics 4 or legacy Universal Analytics and track user interactions automatically." path: /07/plugins/analytics/ file: concepts/07-plugins-analytics.md locale: en version: 07 tags: - id: 07-plugins-building-plugins type: concept title: "Building Plugins" description: "A comprehensive guide to extending docmd with custom logic, data injection, and interactive features." path: /07/plugins/building-plugins/ file: concepts/07-plugins-building-plugins.md locale: en version: 07 tags: - id: 07-plugins-git type: concept title: "Git Plugin" description: "Repository-aware metadata, last-updated timestamps, and automated edit links derived from Git history." path: /07/plugins/git/ file: concepts/07-plugins-git.md locale: en version: 07 tags: - id: 07-plugins-llms type: concept title: "LLM Context Plugin" description: "Optimise your documentation for AI consumption with automated llms.txt and llms-full.txt generation." path: /07/plugins/llms/ file: concepts/07-plugins-llms.md locale: en version: 07 tags: - id: 07-plugins-math type: concept title: "Math Plugin" description: "Native KaTeX/LaTeX mathematics integration for docmd." path: /07/plugins/math/ file: concepts/07-plugins-math.md locale: en version: 07 tags: - id: 07-plugins-mermaid type: concept title: "Mermaid Diagrams" description: "Create professional architectural diagrams, flowcharts, and sequence diagrams directly in your Markdown files using Mermaid.js syntax." path: /07/plugins/mermaid/ file: concepts/07-plugins-mermaid.md locale: en version: 07 tags: - id: 07-plugins-openapi type: concept title: "OpenAPI Plugin" description: "Static API reference documentation rendered directly from OpenAPI 3.x specifications at build-time." path: /07/plugins/openapi/ file: concepts/07-plugins-openapi.md locale: en version: 07 tags: - id: 07-plugins-pwa type: concept title: "PWA & Offline Support" description: "Transform your documentation into a progressive web application with offline caching and mobile-first features." path: /07/plugins/pwa/ file: concepts/07-plugins-pwa.md locale: en version: 07 tags: - id: 07-plugins-search type: concept title: "Search Plugin" description: "Enable high-speed, offline-first full-text search for your documentation using MiniSearch." path: /07/plugins/search/ file: concepts/07-plugins-search.md locale: en version: 07 tags: - id: 07-plugins-seo type: concept title: "SEO Plugin" description: "Optimise your documentation for search engines and control AI crawler access with native meta tag generation." path: /07/plugins/seo/ file: concepts/07-plugins-seo.md locale: en version: 07 tags: - id: 07-plugins-sitemap type: concept title: "Sitemap Plugin" description: "Automatically generate a standard-compliant sitemap.xml for better search engine discovery." path: /07/plugins/sitemap/ file: concepts/07-plugins-sitemap.md locale: en version: 07 tags: - id: 07-plugins-threads type: concept title: "Threads Plugin" description: "Add inline discussion threads to your documentation - stored directly in your markdown files." path: /07/plugins/threads/ file: concepts/07-plugins-threads.md locale: en version: 07 tags: - id: 07-plugins-usage type: concept title: "Using Plugins" description: "Install, configure, and manage docmd plugins - from required defaults to optional add-ons." path: /07/plugins/usage/ file: concepts/07-plugins-usage.md locale: en version: 07 tags: - id: 07-release-notes-0-7-0 type: concept title: "Release Notes - 0.7.0" description: "First-class internationalisation, zero-config core plugins, and true zero-config defaults." path: /07/release-notes/0-7-0/ file: concepts/07-release-notes-0-7-0.md locale: en version: 07 tags: - id: 07-release-notes-0-7-1 type: concept title: "Release Notes - 0.7.1" description: "Dedicated Plugin API package, plugin descriptors, isolation, and capability enforcement." path: /07/release-notes/0-7-1/ file: concepts/07-release-notes-0-7-1.md locale: en version: 07 tags: - id: 07-release-notes-0-7-2 type: concept title: "Release Notes - 0.7.2" description: "Introducing config-aware 'docmd deploy', production security headers, and the 7-pillar failsafe verification engine." path: /07/release-notes/0-7-2/ file: concepts/07-release-notes-0-7-2.md locale: en version: 07 tags: - id: 07-release-notes-0-7-3 type: concept title: "Release Notes - 0.7.3" description: "Introducing code block titles, the multi-service migration engine, interactive Mermaid diagrams with Lucide icons, and first-class Bun ecosystem support." path: /07/release-notes/0-7-3/ file: concepts/07-release-notes-0-7-3.md locale: en version: 07 tags: - id: 07-release-notes-0-7-4 type: concept title: "Release Notes - 0.7.4" description: "Introducing context-aware version filtering for offline search, plus Mermaid icon rendering standardisation." path: /07/release-notes/0-7-4/ file: concepts/07-release-notes-0-7-4.md locale: en version: 07 tags: - id: 07-release-notes-0-7-5 type: concept title: "Release Notes - 0.7.5" description: "Security patch and i18n optimisation: eliminates uuid vulnerability, adds language switcher failsafes, and introduces build-time page manifests for zero-latency locale switching." path: /07/release-notes/0-7-5/ file: concepts/07-release-notes-0-7-5.md locale: en version: 07 tags: - id: 07-release-notes-0-7-6 type: concept title: "Release Notes - 0.7.6" description: "Unified URL normalisation engine, universal external: and raw: link prefixes, SEO trailing-slash enforcement, SPA hash navigation fix, and silent plugin warnings in dev mode." path: /07/release-notes/0-7-6/ file: concepts/07-release-notes-0-7-6.md locale: en version: 07 tags: - id: 07-release-notes-0-7-7 type: concept title: "Release Notes - 0.7.7" description: "Introducing multi-project support, the Universal TUI Design System, and a premium, emoji-free terminal experience for professional documentation workflows." path: /07/release-notes/0-7-7/ file: concepts/07-release-notes-0-7-7.md locale: en version: 07 tags: - id: 07-release-notes-0-7-8 type: concept title: "Release Notes - 0.7.8" description: "Introducing the Git plugin, a redesigned high-signal terminal interface with live progress tracking, parallel page processing for significantly faster builds, auto-installation for official plugins, and container syntax compatibility." path: /07/release-notes/0-7-8/ file: concepts/07-release-notes-0-7-8.md locale: en version: 07 tags: - id: 07-release-notes-0-7-9 type: concept title: "Release Notes - 0.7.9" description: "OpenAPI plugin, Plugin API improvements with onBeforeRender hook and sourcePath, Git plugin commit history accuracy fix for multi-project builds, contributor avatars, and smart sticky footer." path: /07/release-notes/0-7-9/ file: concepts/07-release-notes-0-7-9.md locale: en version: 07 tags: - id: 07-theming-assets-management type: concept title: "Assets Management" description: "How docmd handles CSS, JavaScript, and Image assets during the build process." path: /07/theming/assets-management/ file: concepts/07-theming-assets-management.md locale: en version: 07 tags: - id: 07-theming-available-themes type: concept title: "Available Themes" description: "Explore docmd's built-in themes including Sky, Ruby, and Retro. Learn how to switch themes with a single config line." path: /07/theming/available-themes/ file: concepts/07-theming-available-themes.md locale: en version: 07 tags: - id: 07-theming-custom-css-js type: concept title: "Custom Styles & Scripts" description: "Inject your own CSS and JS files to extend docmd's functionality and branding." path: /07/theming/custom-css-js/ file: concepts/07-theming-custom-css-js.md locale: en version: 07 tags: - id: 07-theming-customisation type: concept title: "Customisation & Variables" description: "A complete reference of docmd's CSS variables and component classes for advanced styling." path: /07/theming/customisation/ file: concepts/07-theming-customisation.md locale: en version: 07 tags: - id: 07-theming-icons type: concept title: Icons description: "How to use and customise Lucide icons in your documentation." path: /07/theming/icons/ file: concepts/07-theming-icons.md locale: en version: 07 tags: - id: 07-theming-light-dark-mode type: concept title: "Light & Dark Mode" description: "How to configure the default viewing mode and manage the theme switcher for the best user experience." path: /07/theming/light-dark-mode/ file: concepts/07-theming-light-dark-mode.md locale: en version: 07 tags: - id: 06-advanced-developer-guide type: concept title: "Developer Guide" description: "Professional automated onboarding, verification, and maintenance workflows for docmd contributors." path: /06/advanced/developer-guide/ file: concepts/06-advanced-developer-guide.md locale: en version: 06 tags: - id: 06-api-browser-api type: concept title: "Browser API (Client-Side)" description: "Interact with docmd from the browser - live compilation and dev-mode plugin communication." path: /06/api/browser-api/ file: concepts/06-api-browser-api.md locale: en version: 06 tags: - id: 06-api-client-side-events type: concept title: "Client-Side Events" description: "Hook into the docmd SPA lifecycle to add interactive features." path: /06/api/client-side-events/ file: concepts/06-api-client-side-events.md locale: en version: 06 tags: - id: 06-api-live-api type: concept title: "Live Editor" description: "Understanding the docmd Live Editor and its browser-based authoring workflow." path: /06/api/live-api/ file: concepts/06-api-live-api.md locale: en version: 06 tags: - id: 06-api-node-api type: concept title: "Node.js API" description: "Integrate docmd's build engine into your custom Node.js scripts and automation pipelines." path: /06/api/node-api/ file: concepts/06-api-node-api.md locale: en version: 06 tags: - id: 06-cli-commands type: concept title: "CLI Commands" description: "The complete command-line interface reference for docmd." path: /06/cli-commands/ file: concepts/06-cli-commands.md locale: en version: 06 tags: - id: 06-comparison type: concept title: "Comparing Documentation Tools" description: "A professional comparison between docmd and other popular documentation generators like Docusaurus, MkDocs, and Mintlify." path: /06/comparison/ file: concepts/06-comparison.md locale: en version: 06 tags: - id: 06-configuration-general type: concept title: "General Configuration" description: "Master the docmd.config.js schema. Configure branding, layout architecture, and core engine features." path: /06/configuration/general/ file: concepts/06-configuration-general.md locale: en version: 06 tags: - id: 06-configuration-layout-slots type: concept title: "Layout & UI Zones" description: "Control the interface structure by managing headers, sidebars, and functional UI slots." path: /06/configuration/layout-slots/ file: concepts/06-configuration-layout-slots.md locale: en version: 06 tags: - id: 06-configuration-menubar type: concept title: Menubar description: "Structure and position your menubar, manage navigation links, and configure drop-down menus." path: /06/configuration/menubar/ file: concepts/06-configuration-menubar.md locale: en version: 06 tags: - id: 06-configuration-navigation type: concept title: "Navigation Configuration" description: "Structure your sidebar, categorize links, and assign icons for both human readers and AI models." path: /06/configuration/navigation/ file: concepts/06-configuration-navigation.md locale: en version: 06 tags: - id: 06-configuration-redirects type: concept title: "Redirects & 404" description: "Configure metadata-based redirects and custom branded 404 error pages for static deployments." path: /06/configuration/redirects/ file: concepts/06-configuration-redirects.md locale: en version: 06 tags: - id: 06-configuration-versioning type: concept title: Versioning description: "Enable multi-version documentation with seamless switching, sticky path preservation, and isolated build directories." path: /06/configuration/versioning/ file: concepts/06-configuration-versioning.md locale: en version: 06 tags: - id: 06-content-containers-buttons type: concept title: Buttons description: "Inject call-to-action buttons for internal routing or external resources with a minimalist syntax." path: /06/content/containers/buttons/ file: concepts/06-content-containers-buttons.md locale: en version: 06 tags: - id: 06-content-containers-callouts type: concept title: Callouts description: "Highlight critical warnings, pro-tips, and background context using semantic visual blocks." path: /06/content/containers/callouts/ file: concepts/06-content-containers-callouts.md locale: en version: 06 tags: - id: 06-content-containers-cards type: concept title: Cards description: "Organise information into framed, visually distinct containers. Perfect for feature grids and landing pages." path: /06/content/containers/cards/ file: concepts/06-content-containers-cards.md locale: en version: 06 tags: - id: 06-content-containers-changelogs type: concept title: Changelogs description: "Generate structured, timeline-based version history and release notes." path: /06/content/containers/changelogs/ file: concepts/06-content-containers-changelogs.md locale: en version: 06 tags: - id: 06-content-containers-collapsible type: concept title: "Collapsible Sections" description: "Embed interactive accordion-style toggles for FAQs, deep-dive content, and spoilers." path: /06/content/containers/collapsible/ file: concepts/06-content-containers-collapsible.md locale: en version: 06 tags: - id: 06-content-containers-embed type: concept title: "URL Embeds" description: "How to safely embed dynamic components, videos, and social media directly into your documents." path: /06/content/containers/embed/ file: concepts/06-content-containers-embed.md locale: en version: 06 tags: - id: 06-content-containers-grids type: concept title: Grids description: "Organise layout easily with auto-adjusting responsive columns using native markdown containers." path: /06/content/containers/grids/ file: concepts/06-content-containers-grids.md locale: en version: 06 tags: - id: 06-content-containers-hero type: concept title: "Hero Sections" description: "Build high-impact landing page headers and marketing highlights purely in Markdown." path: /06/content/containers/hero/ file: concepts/06-content-containers-hero.md locale: en version: 06 tags: - id: 06-content-containers type: concept title: "Custom Interactive Containers" description: "A comprehensive directory of the interactive UI building blocks available in docmd." path: /06/content/containers/ file: concepts/06-content-containers.md locale: en version: 06 tags: - id: 06-content-containers-nested-containers type: concept title: "Nested Containers" description: "Use docmd's recursive parser to combine cards, tabs, and callouts into high-fidelity page layouts." path: /06/content/containers/nested-containers/ file: concepts/06-content-containers-nested-containers.md locale: en version: 06 tags: - id: 06-content-containers-steps type: concept title: Steps description: "Convert standard ordered lists into high-impact visual timelines and tutorials." path: /06/content/containers/steps/ file: concepts/06-content-containers-steps.md locale: en version: 06 tags: - id: 06-content-containers-tabs type: concept title: Tabs description: "Organise dense, alternative, or multi-language information into switchable interactive panes." path: /06/content/containers/tabs/ file: concepts/06-content-containers-tabs.md locale: en version: 06 tags: - id: 06-content-frontmatter type: concept title: "Frontmatter Reference" description: "The complete guide to page-level metadata and configuration in docmd." path: /06/content/frontmatter/ file: concepts/06-content-frontmatter.md locale: en version: 06 tags: - id: 06-content-live-preview type: concept title: "Live Preview" description: "Run docmd entirely in the browser without a backend server using the Live architecture." path: /06/content/live-preview/ file: concepts/06-content-live-preview.md locale: en version: 06 tags: - id: 06-content-no-style-example type: concept title: "docmd : Bespoke No-Style Page Demo" description: "A functional demonstration of the noStyle architectural feature." path: /06/content/no-style-example/ file: concepts/06-content-no-style-example.md locale: en version: 06 tags: - id: 06-content-no-style-pages type: concept title: "No-Style Pages" description: "Create custom landing pages and unique layouts by disabling the default docmd theme." path: /06/content/no-style-pages/ file: concepts/06-content-no-style-pages.md locale: en version: 06 tags: - id: 06-content-syntax-advanced type: concept title: "Advanced Markdown Syntax" description: "Use docmd's extended feature set: Custom attributes, GFM extensions, and semantic definitions." path: /06/content/syntax/advanced/ file: concepts/06-content-syntax-advanced.md locale: en version: 06 tags: - id: 06-content-syntax-code type: concept title: "Code Blocks" description: "Document technical implementations with high-fidelity syntax highlighting and interactive copy buttons." path: /06/content/syntax/code/ file: concepts/06-content-syntax-code.md locale: en version: 06 tags: - id: 06-content-syntax-images type: concept title: "Images & Visual Media" description: "Master media management: Responsive images, styling attributes, and automated Lightbox effects." path: /06/content/syntax/images/ file: concepts/06-content-syntax-images.md locale: en version: 06 tags: - id: 06-content-syntax type: concept title: "Markdown Syntax Foundation" description: "Master the fundamental formatting rules of docmd: Headings, typographic styles, and technical blocks." path: /06/content/syntax/ file: concepts/06-content-syntax.md locale: en version: 06 tags: - id: 06-content-syntax-linking type: concept title: "Linking & Referencing" description: "Master internal cross-linking, external resources, and reliable asset referencing." path: /06/content/syntax/linking/ file: concepts/06-content-syntax-linking.md locale: en version: 06 tags: - id: 06-contributing type: concept title: Contributing description: "Guidelines and setup instructions for contributing to docmd." path: /06/contributing/ file: concepts/06-contributing.md locale: en version: 06 tags: - id: 06-deployment type: concept title: Deployment description: "Host your docmd documentation on platforms like GitHub Pages, Vercel, Netlify, and Cloudflare Pages." path: /06/deployment/ file: concepts/06-deployment.md locale: en version: 06 tags: - id: 06-getting-started-basic-usage type: concept title: "Basic Usage" description: "Learn how to initialise a project, organise your Markdown files, and build your documentation site." path: /06/getting-started/basic-usage/ file: concepts/06-getting-started-basic-usage.md locale: en version: 06 tags: - id: 06-getting-started-installation type: concept title: Installation description: "Instructions for installing docmd globally, locally, or using it on-the-fly with npx." path: /06/getting-started/installation/ file: concepts/06-getting-started-installation.md locale: en version: 06 tags: - id: 06-getting-started-zero-config type: concept title: "Zero-Config Mode" description: "Execute docmd without a configuration file. Ideal for rapid prototyping and instant documentation previews." path: /06/getting-started/zero-config/ file: concepts/06-getting-started-zero-config.md locale: en version: 06 tags: - id: 06 type: concept title: "Documentation for docmd: The Minimalist Docs Generator" description: "Generate beautiful, lightweight, and blazing-fast documentation sites directly from your Markdown files. Zero clutter, just content." path: /06/ file: concepts/06.md locale: en version: 06 tags: - id: 06-plugins-analytics type: concept title: "Analytics Plugin" description: "Integrate Google Analytics 4 or Legacy Universal Analytics and track user interactions automatically." path: /06/plugins/analytics/ file: concepts/06-plugins-analytics.md locale: en version: 06 tags: - id: 06-plugins-building-plugins type: concept title: "Building Plugins" description: "A comprehensive guide to extending docmd with custom logic and interactive features." path: /06/plugins/building-plugins/ file: concepts/06-plugins-building-plugins.md locale: en version: 06 tags: - id: 06-plugins-llms type: concept title: "LLM Context Plugin" description: "Optimised your documentation for AI Consumption with automated llms.txt and llms-full.txt generation." path: /06/plugins/llms/ file: concepts/06-plugins-llms.md locale: en version: 06 tags: - id: 06-plugins-math type: concept title: "Math Plugin" description: "Native KaTeX/LaTeX mathematics integration for docmd." path: /06/plugins/math/ file: concepts/06-plugins-math.md locale: en version: 06 tags: - id: 06-plugins-mermaid type: concept title: "Mermaid Diagrams" description: "Create professional architectural diagrams, flowcharts, and sequence diagrams directly in your Markdown files using Mermaid.js syntax." path: /06/plugins/mermaid/ file: concepts/06-plugins-mermaid.md locale: en version: 06 tags: - id: 06-plugins-pwa type: concept title: "PWA & Offline Support" description: "Transform your documentation into a progressive web application with offline caching and mobile-first features." path: /06/plugins/pwa/ file: concepts/06-plugins-pwa.md locale: en version: 06 tags: - id: 06-plugins-search type: concept title: "Search Plugin" description: "Enable high-speed, offline-first full-text search for your documentation using MiniSearch." path: /06/plugins/search/ file: concepts/06-plugins-search.md locale: en version: 06 tags: - id: 06-plugins-seo type: concept title: "SEO Plugin" description: "Optimise your documentation for search engines and control AI crawler access with native meta tag generation." path: /06/plugins/seo/ file: concepts/06-plugins-seo.md locale: en version: 06 tags: - id: 06-plugins-sitemap type: concept title: "Sitemap Plugin" description: "Automatically generate a standard-compliant sitemap.xml for better search engine discovery." path: /06/plugins/sitemap/ file: concepts/06-plugins-sitemap.md locale: en version: 06 tags: - id: 06-plugins-threads type: concept title: "Threads Plugin" description: "Add inline discussion threads to your documentation - stored directly in your markdown files." path: /06/plugins/threads/ file: concepts/06-plugins-threads.md locale: en version: 06 tags: - id: 06-plugins-usage type: concept title: "Using Plugins" description: "Install, configure, and manage docmd plugins - from required defaults to optional add-ons." path: /06/plugins/usage/ file: concepts/06-plugins-usage.md locale: en version: 06 tags: - id: 06-recipes-ai-optimisation type: concept title: "Recipe: Optimising for AI Agents" description: "Engineer your documentation for maximum ingestibility by LLMs and AI Agents." path: /06/recipes/ai-optimisation/ file: concepts/06-recipes-ai-optimisation.md locale: en version: 06 tags: - id: 06-recipes-custom-fonts type: concept title: "Recipe: Integrating Custom Fonts" description: "Personalize your site's typography via Google Fonts and CSS variable overrides." path: /06/recipes/custom-fonts/ file: concepts/06-recipes-custom-fonts.md locale: en version: 06 tags: - id: 06-recipes-favicon type: concept title: "Recipe: Implementing Custom Favicons" description: "Establish project-wide branding by adding a custom favicon to your build." path: /06/recipes/favicon/ file: concepts/06-recipes-favicon.md locale: en version: 06 tags: - id: 06-recipes-landing-page type: concept title: "Recipe: Designing Custom Landing Pages" description: "Master the noStyle mode to create high-impact marketing pages and product entries." path: /06/recipes/landing-page/ file: concepts/06-recipes-landing-page.md locale: en version: 06 tags: - id: 06-recipes-writing-guide type: concept title: "Recipe: Technical Writing Standards" description: "Best practices for authoring clear, scannable, and AI-optimised documentation." path: /06/recipes/writing-guide/ file: concepts/06-recipes-writing-guide.md locale: en version: 06 tags: - id: 06-release-notes-0-6-0 type: concept title: "Release notes for docmd 0.6.0 release" description: "Monorepo TypeScript & ESM migration, docmd Dev Environment Tools suite, and CI/CD automation." path: /06/release-notes/0-6-0/ file: concepts/06-release-notes-0-6-0.md locale: en version: 06 tags: - id: 06-release-notes-0-6-1 type: concept title: "Release notes for docmd 0.6.1 release" description: "Hotfix release resolving NPM publishing failures and an installer runtime error." path: /06/release-notes/0-6-1/ file: concepts/06-release-notes-0-6-1.md locale: en version: 06 tags: - id: 06-release-notes-0-6-2 type: concept title: "Release notes for docmd 0.6.2 release" description: "Smart Version Switcher, Navigation V2 (navigation.json), Breadcrumbs, Analytics V2, and core security fixes." path: /06/release-notes/0-6-2/ file: concepts/06-release-notes-0-6-2.md locale: en version: 06 tags: - id: 06-release-notes-0-6-3 type: concept title: "Release notes for docmd 0.6.3 release" description: "Contextual Heading IDs, improved Table of Contents accuracy, and deep-link disambiguation." path: /06/release-notes/0-6-3/ file: concepts/06-release-notes-0-6-3.md locale: en version: 06 tags: - id: 06-release-notes-0-6-4 type: concept title: "Release notes for docmd 0.6.4 release" description: "Reliable Emoji Parsing, Auto-Adjusting Grids Container, and Dependency Security." path: /06/release-notes/0-6-4/ file: concepts/06-release-notes-0-6-4.md locale: en version: 06 tags: - id: 06-release-notes-0-6-5 type: concept title: "Release notes for docmd 0.6.5 release" description: "Zero-Latency URL Embeds Engine, Massive Ecosystem Integrations, and Sandbox Hardening." path: /06/release-notes/0-6-5/ file: concepts/06-release-notes-0-6-5.md locale: en version: 06 tags: - id: 06-release-notes-0-6-6 type: concept title: "Release notes for docmd 0.6.6 release" description: "The Great Shedding - removing massive dependencies in favour of ultra-light, zero-config in-house packages." path: /06/release-notes/0-6-6/ file: concepts/06-release-notes-0-6-6.md locale: en version: 06 tags: - id: 06-release-notes-0-6-7 type: concept title: "Release notes for docmd 0.6.7 release" description: "Live Build Engine Optimisation and Absolute Path Correction." path: /06/release-notes/0-6-7/ file: concepts/06-release-notes-0-6-7.md locale: en version: 06 tags: - id: 06-release-notes-0-6-8 type: concept title: "Release notes for docmd 0.6.8 release" description: "Plugin API expansion with WebSocket RPC, source editing tools, and the new threads plugin." path: /06/release-notes/0-6-8/ file: concepts/06-release-notes-0-6-8.md locale: en version: 06 tags: - id: 06-release-notes-0-6-9 type: concept title: "Release notes for docmd 0.6.9 release" description: "Core architectural stability, reliable plugin dynamic resolution, and the official KaTeX math plugin." path: /06/release-notes/0-6-9/ file: concepts/06-release-notes-0-6-9.md locale: en version: 06 tags: - id: 06-theming-assets-management type: concept title: "Assets Management" description: "How docmd handles CSS, JavaScript, and Image assets during the build process." path: /06/theming/assets-management/ file: concepts/06-theming-assets-management.md locale: en version: 06 tags: - id: 06-theming-available-themes type: concept title: "Available Themes" description: "Explore docmd's built-in themes including Sky, Ruby, and Retro. Learn how to switch themes with a single config line." path: /06/theming/available-themes/ file: concepts/06-theming-available-themes.md locale: en version: 06 tags: - id: 06-theming-custom-css-js type: concept title: "Custom Styles & Scripts" description: "Inject your own CSS and JS files to extend docmd's functionality and branding." path: /06/theming/custom-css-js/ file: concepts/06-theming-custom-css-js.md locale: en version: 06 tags: - id: 06-theming-customisation type: concept title: "Customisation & Variables" description: "A complete reference of docmd's CSS variables and component classes for advanced styling." path: /06/theming/customisation/ file: concepts/06-theming-customisation.md locale: en version: 06 tags: - id: 06-theming-icons type: concept title: Icons description: "How to use and customise Lucide icons in your documentation." path: /06/theming/icons/ file: concepts/06-theming-icons.md locale: en version: 06 tags: - id: 06-theming-light-dark-mode type: concept title: "Light & Dark Mode" description: "How to configure the default viewing mode and manage the theme switcher for the best user experience." path: /06/theming/light-dark-mode/ file: concepts/06-theming-light-dark-mode.md locale: en version: 06 tags: - id: 05-advanced-browser-api type: concept title: "Browser API (Client-Side)" description: "How to use the docmd engine directly in the browser to render documentation dynamically without a server." path: /05/advanced/browser-api/ file: concepts/05-advanced-browser-api.md locale: en version: 05 tags: - id: 05-advanced-client-side-events type: concept title: "Client-Side Events" description: "Hook into the docmd SPA router for custom interactive features." path: /05/advanced/client-side-events/ file: concepts/05-advanced-client-side-events.md locale: en version: 05 tags: - id: 05-advanced-developer-guide type: concept title: "Developer Guide" description: "Advanced debugging, testing, and contribution tools for developers working directly on the docmd monorepo." path: /05/advanced/developer-guide/ file: concepts/05-advanced-developer-guide.md locale: en version: 05 tags: - id: 05-advanced-node-api type: concept title: "Programmatic Node API" description: "Integrate docmd's build engine directly into your custom Node.js scripts and automation pipelines." path: /05/advanced/node-api/ file: concepts/05-advanced-node-api.md locale: en version: 05 tags: - id: 05-cli-commands type: concept title: "CLI Commands" description: "The complete command-line reference for docmd. Create, build, and deploy your documentation with ease." path: /05/cli-commands/ file: concepts/05-cli-commands.md locale: en version: 05 tags: - id: 05-comparison type: concept title: "Comparing Documentation Tools" description: "See how docmd stacks up against Docusaurus, MkDocs, Mintlify, and other documentation generators." path: /05/comparison/ file: concepts/05-comparison.md locale: en version: 05 tags: - id: 05-configuration-general type: concept title: "General Configuration" description: "Master the docmd.config.js schema. Configure branding, layout architecture, and core engine features." path: /05/configuration/general/ file: concepts/05-configuration-general.md locale: en version: 05 tags: - id: 05-configuration-layout-slots type: concept title: "Layout & UI Slots" description: "Master the structure of docmd by controlling headers, sidebars, and functional slots." path: /05/configuration/layout-slots/ file: concepts/05-configuration-layout-slots.md locale: en version: 05 tags: - id: 05-configuration-menubar type: concept title: Menubar description: "How to structure and position your menubar, add links, drop-down menus and icons." path: /05/configuration/menubar/ file: concepts/05-configuration-menubar.md locale: en version: 05 tags: - id: 05-configuration-navigation type: concept title: "Navigation Configuration" description: "How to structure your sidebar, categorize links, and assign icons for both humans and AI models." path: /05/configuration/navigation/ file: concepts/05-configuration-navigation.md locale: en version: 05 tags: - id: 05-configuration-redirects type: concept title: "Redirects & 404" description: "Configure instant metadata-based redirects and custom branded 404 error pages for static deployments." path: /05/configuration/redirects/ file: concepts/05-configuration-redirects.md locale: en version: 05 tags: - id: 05-configuration-versioning type: concept title: Versioning description: "Enable multi-version documentation with seamless switching, sticky path preservation, and isolated build directories." path: /05/configuration/versioning/ file: concepts/05-configuration-versioning.md locale: en version: 05 tags: - id: 05-content-containers-buttons type: concept title: Buttons description: "Inject call-to-action buttons for internal routing or external resources. No closing tag required." path: /05/content/containers/buttons/ file: concepts/05-content-containers-buttons.md locale: en version: 05 tags: - id: 05-content-containers-callouts type: concept title: Callouts description: "Highlight critical information using semantic blocks. Supports Tip, Warning, Danger, and Info types." path: /05/content/containers/callouts/ file: concepts/05-content-containers-callouts.md locale: en version: 05 tags: - id: 05-content-containers-cards type: concept title: Cards description: "Organise information into framed, visually distinct blocks. Ideal for landing pages and feature grids." path: /05/content/containers/cards/ file: concepts/05-content-containers-cards.md locale: en version: 05 tags: - id: 05-content-containers-changelogs type: concept title: Changelogs description: "Create beautiful, timeline-based version history pages." path: /05/content/containers/changelogs/ file: concepts/05-content-containers-changelogs.md locale: en version: 05 tags: - id: 05-content-containers-collapsible type: concept title: Collapsible description: "Create toggleable accordion sections for FAQs and advanced details." path: /05/content/containers/collapsible/ file: concepts/05-content-containers-collapsible.md locale: en version: 05 tags: - id: 05-content-containers type: concept title: "Custom Containers" description: "A directory of the interactive UI components available in docmd. Cards, Tabs, Callouts, and more." path: /05/content/containers/ file: concepts/05-content-containers.md locale: en version: 05 tags: - id: 05-content-containers-nested-containers type: concept title: "Nested Containers" description: "Master docmd's recursive parser. Learn how to combine cards, tabs, and callouts to build complex, interactive page layouts." path: /05/content/containers/nested-containers/ file: concepts/05-content-containers-nested-containers.md locale: en version: 05 tags: - id: 05-content-containers-steps type: concept title: Steps description: "Transform standard numbered lists into high-impact visual timelines of instructions." path: /05/content/containers/steps/ file: concepts/05-content-containers-steps.md locale: en version: 05 tags: - id: 05-content-containers-tabs type: concept title: Tabs description: "Organise alternative or dense information into switchable panes. Perfect for multi-language code snippets." path: /05/content/containers/tabs/ file: concepts/05-content-containers-tabs.md locale: en version: 05 tags: - id: 05-content-frontmatter type: concept title: "Frontmatter Reference" description: "The complete guide to page-level metadata and configuration in docmd." path: /05/content/frontmatter/ file: concepts/05-content-frontmatter.md locale: en version: 05 tags: - id: 05-content-live-preview type: concept title: "Live Preview & Browser Support" description: "Run docmd entirely in the browser without a server using the new Live architecture." path: /05/content/live-preview/ file: concepts/05-content-live-preview.md locale: en version: 05 tags: - id: 05-content-no-style-example type: concept title: "docmd : No-Style Page Example" description: "An example of a page using the no-style feature" path: /05/content/no-style-example/ file: concepts/05-content-no-style-example.md locale: en version: 05 tags: - id: 05-content-no-style-pages type: concept title: "No-Style Pages" description: "Create landing pages and custom layouts by disabling the default docmd theme." path: /05/content/no-style-pages/ file: concepts/05-content-no-style-pages.md locale: en version: 05 tags: - id: 05-content-syntax-advanced type: concept title: "Advanced Syntax" description: "Master docmd's extended Markdown features: Task lists, custom attributes, footnotes, and more." path: /05/content/syntax/advanced/ file: concepts/05-content-syntax-advanced.md locale: en version: 05 tags: - id: 05-content-syntax-code type: concept title: "Code Blocks" description: "Document your code with automatic syntax highlighting, line numbers, and copy buttons." path: /05/content/syntax/code/ file: concepts/05-content-syntax-code.md locale: en version: 05 tags: - id: 05-content-syntax-images type: concept title: "Images & Lightbox" description: "Adding images, styling galleries, and enabling lightbox zoom effects." path: /05/content/syntax/images/ file: concepts/05-content-syntax-images.md locale: en version: 05 tags: - id: 05-content-syntax type: concept title: "Markdown Syntax" description: "Master the basic formatting of docmd: Headings, lists, bold, italic, and more." path: /05/content/syntax/ file: concepts/05-content-syntax.md locale: en version: 05 tags: - id: 05-content-syntax-linking type: concept title: "Linking & Referencing" description: "Master internal cross-linking, external links, and asset referencing." path: /05/content/syntax/linking/ file: concepts/05-content-syntax-linking.md locale: en version: 05 tags: - id: 05-contributing type: concept title: Contributing description: "Learn how you can contribute to the development, design, and documentation of docmd." path: /05/contributing/ file: concepts/05-contributing.md locale: en version: 05 tags: - id: 05-deployment type: concept title: "Deployment (Deploy Your Website)" description: "Learn how to deploy your docmd-generated static site to modern hosting platforms like GitHub Pages, Vercel, and Netlify." path: /05/deployment/ file: concepts/05-deployment.md locale: en version: 05 tags: - id: 05-getting-started-basic-usage type: concept title: "Basic Usage" description: "Learn how to initialise a project, organise your markdown files, and build your documentation site." path: /05/getting-started/basic-usage/ file: concepts/05-getting-started-basic-usage.md locale: en version: 05 tags: - id: 05-getting-started-installation type: concept title: Installation description: "How to install docmd globally or locally using npm, yarn, or pnpm." path: /05/getting-started/installation/ file: concepts/05-getting-started-installation.md locale: en version: 05 tags: - id: 05-getting-started-zero-config type: concept title: "Zero-Config Mode" description: "Run docmd without any configuration file. Perfect for quick previews and rapid prototyping." path: /05/getting-started/zero-config/ file: concepts/05-getting-started-zero-config.md locale: en version: 05 tags: - id: 05 type: concept title: "docmd: The Minimalist Docs Generator" description: "Generate beautiful, lightweight, and blazing-fast documentation sites directly from your Markdown files. Zero clutter, just content." path: /05/ file: concepts/05.md locale: en version: 05 tags: - id: 05-plugins-analytics type: concept title: "Analytics Integration" description: "Integrate Google Analytics or other tracking services into your docmd site." path: /05/plugins/analytics/ file: concepts/05-plugins-analytics.md locale: en version: 05 tags: - id: 05-plugins-building-plugins type: concept title: "Building Plugins" description: "A guide for developers on how to create and share custom docmd plugins." path: /05/plugins/building-plugins/ file: concepts/05-plugins-building-plugins.md locale: en version: 05 tags: - id: 05-plugins-installer type: concept title: "Plugin Installer" description: "How to use the docmd plugin installer to easily add and configure plugins." path: /05/plugins/installer/ file: concepts/05-plugins-installer.md locale: en version: 05 tags: - id: 05-plugins-llms type: concept title: "AI Support (llms.txt)" description: "Turn your documentation into a first-class API for Large Language Models using the native llms.txt and llms-full.txt generation." path: /05/plugins/llms/ file: concepts/05-plugins-llms.md locale: en version: 05 tags: - id: 05-plugins-mermaid type: concept title: "Mermaid Diagrams" description: "Native support for Mermaid.js. Create flowcharts, sequence diagrams, and pie charts directly in your Markdown files." path: /05/plugins/mermaid/ file: concepts/05-plugins-mermaid.md locale: en version: 05 tags: - id: 05-plugins-pwa type: concept title: "PWA Plugin" description: "Turn your documentation into a blazingly fast installable App using the zero-config PWA plugin." path: /05/plugins/pwa/ file: concepts/05-plugins-pwa.md locale: en version: 05 tags: - id: 05-plugins-search type: concept title: "Search Plugin" description: "Configure docmd's zero-config, privacy-focused offline search engine with section-deep linking." path: /05/plugins/search/ file: concepts/05-plugins-search.md locale: en version: 05 tags: - id: 05-plugins-seo type: concept title: "SEO & Meta Tags" description: "Automatic SEO optimisation, Open Graph integration, and AI Scraper control for your docmd site." path: /05/plugins/seo/ file: concepts/05-plugins-seo.md locale: en version: 05 tags: - id: 05-plugins-sitemap type: concept title: "Sitemap Plugin" description: "Automatically generate sitemap.xml to improve search engine discoverability." path: /05/plugins/sitemap/ file: concepts/05-plugins-sitemap.md locale: en version: 05 tags: - id: 05-plugins-usage type: concept title: "Using Plugins" description: "How to enable and configure docmd's powerful plugin ecosystem." path: /05/plugins/usage/ file: concepts/05-plugins-usage.md locale: en version: 05 tags: - id: 05-recipes-ai-optimisation type: concept title: "Recipe: Optimising for AI Agents" description: "How to structure your docmd site to be perfectly ingestible by LLMs and AI Agents." path: /05/recipes/ai-optimisation/ file: concepts/05-recipes-ai-optimisation.md locale: en version: 05 tags: - id: 05-recipes-custom-fonts type: concept title: "Recipe: Adding Custom Fonts" description: "Personalize your documentation by importing Google Fonts." path: /05/recipes/custom-fonts/ file: concepts/05-recipes-custom-fonts.md locale: en version: 05 tags: - id: 05-recipes-favicon type: concept title: "Recipe: Adding a Custom Favicon" description: "How to add a custom favicon to your documentation site." path: /05/recipes/favicon/ file: concepts/05-recipes-favicon.md locale: en version: 05 tags: - id: 05-recipes-landing-page type: concept title: "Recipe: Creating a Landing Page" description: "How to build a custom landing page using noStyle." path: /05/recipes/landing-page/ file: concepts/05-recipes-landing-page.md locale: en version: 05 tags: - id: 05-recipes-writing-guide type: concept title: "Recipe: Documentation Writing Guide" description: "Best practices for writing clear, scannable, and effective documentation with docmd." path: /05/recipes/writing-guide/ file: concepts/05-recipes-writing-guide.md locale: en version: 05 tags: - id: 05-release-notes-0-5-0 type: concept title: "Release Note for docmd 0.5.0" description: "PWA & AI First docmd 0.5.0 Release Notes" path: /05/release-notes/0-5-0/ file: concepts/05-release-notes-0-5-0.md locale: en version: 05 tags: - id: 05-release-notes-0-5-1 type: concept title: "Release Note for docmd 0.5.1" description: "PWA & AI First docmd 0.5.1 Release Notes" path: /05/release-notes/0-5-1/ file: concepts/05-release-notes-0-5-1.md locale: en version: 05 tags: - id: 05-release-notes-0-5-2 type: concept title: "Release Note for docmd 0.5.2" description: "Menubar & Dev-UX docmd 0.5.2 Release Notes" path: /05/release-notes/0-5-2/ file: concepts/05-release-notes-0-5-2.md locale: en version: 05 tags: - id: 05-release-notes-0-5-3 type: concept title: v0.5.4 description: "Theme improvements, developer control, and internal architecture improvements." path: /05/release-notes/0-5-3/ file: concepts/05-release-notes-0-5-3.md locale: en version: 05 tags: - id: 05-release-notes-0-5-4 type: concept title: v0.5.4 description: "Plugin Installer architecture, resilient config migrations, and rendering fixes." path: /05/release-notes/0-5-4/ file: concepts/05-release-notes-0-5-4.md locale: en version: 05 tags: - id: 05-theming-assets-management type: concept title: "Assets Management" description: "How docmd handles CSS, JavaScript, and Image assets during the build process." path: /05/theming/assets-management/ file: concepts/05-theming-assets-management.md locale: en version: 05 tags: - id: 05-theming-available-themes type: concept title: "Available Themes" description: "Explore docmd's built-in themes including Sky, Ruby, and Retro. Learn how to switch themes with a single config line." path: /05/theming/available-themes/ file: concepts/05-theming-available-themes.md locale: en version: 05 tags: - id: 05-theming-custom-css-js type: concept title: "Custom Styles & Scripts" description: "Inject your own CSS and JS files to extend docmd's functionality and branding." path: /05/theming/custom-css-js/ file: concepts/05-theming-custom-css-js.md locale: en version: 05 tags: - id: 05-theming-customisation type: concept title: "Customisation & Variables" description: "A complete reference of docmd's CSS variables and component classes for advanced styling." path: /05/theming/customisation/ file: concepts/05-theming-customisation.md locale: en version: 05 tags: - id: 05-theming-icons type: concept title: Icons description: "How to use and customise Lucide icons in your documentation." path: /05/theming/icons/ file: concepts/05-theming-icons.md locale: en version: 05 tags: - id: 05-theming-light-dark-mode type: concept title: "Light & Dark Mode" description: "How to configure the default viewing mode and manage the theme switcher for the best user experience." path: /05/theming/light-dark-mode/ file: concepts/05-theming-light-dark-mode.md locale: en version: 05 tags: - id: 04-advanced-browser-api type: concept title: "Browser API (Client-Side)" description: "How to use the docmd engine directly in the browser to render documentation dynamically without a server." path: /04/advanced/browser-api/ file: concepts/04-advanced-browser-api.md locale: en version: 04 tags: - id: 04-advanced-client-side-events type: concept title: "Client-Side Events" description: "Hook into the docmd SPA router for custom interactive features." path: /04/advanced/client-side-events/ file: concepts/04-advanced-client-side-events.md locale: en version: 04 tags: - id: 04-advanced-node-api type: concept title: "Programmatic API" description: "Programmatic API for building docmd sites from your own scripts." path: /04/advanced/node-api/ file: concepts/04-advanced-node-api.md locale: en version: 04 tags: - id: 04-cli-commands type: concept title: "CLI Commands" description: "A complete reference guide to the docmd command-line interface and its available options." path: /04/cli-commands/ file: concepts/04-cli-commands.md locale: en version: 04 tags: - id: 04-comparison type: concept title: "Comparing Documentation Tools" description: "See how docmd stacks up against Docusaurus, MkDocs, Mintlify, and other documentation generators." path: /04/comparison/ file: concepts/04-comparison.md locale: en version: 04 tags: - id: 04-configuration-general type: concept title: "General Configuration" description: "Configure the core settings, layout, and appearance of your docmd site." path: /04/configuration/general/ file: concepts/04-configuration-general.md locale: en version: 04 tags: - id: 04-configuration-layout-slots type: concept title: "Layout & UI Slots" description: "Master the structure of docmd by controlling headers, sidebars, and functional slots." path: /04/configuration/layout-slots/ file: concepts/04-configuration-layout-slots.md locale: en version: 04 tags: - id: 04-configuration-navigation type: concept title: "Navigation Configuration" description: "Configure your sidebar links, nested groups, icons, and category labels." path: /04/configuration/navigation/ file: concepts/04-configuration-navigation.md locale: en version: 04 tags: - id: 04-content-containers-buttons type: concept title: Buttons description: "Create call-to-action buttons for links, downloads, and external resources." path: /04/content/containers/buttons/ file: concepts/04-content-containers-buttons.md locale: en version: 04 tags: - id: 04-content-containers-callouts type: concept title: Callouts description: "Highlight important information using semantic callout blocks." path: /04/content/containers/callouts/ file: concepts/04-content-containers-callouts.md locale: en version: 04 tags: - id: 04-content-containers-cards type: concept title: Cards description: "Group content into visually distinct, framed boxes." path: /04/content/containers/cards/ file: concepts/04-content-containers-cards.md locale: en version: 04 tags: - id: 04-content-containers-changelogs type: concept title: Changelogs description: "Create beautiful, timeline-based version history pages." path: /04/content/containers/changelogs/ file: concepts/04-content-containers-changelogs.md locale: en version: 04 tags: - id: 04-content-containers-collapsible type: concept title: Collapsible description: "Create toggleable accordion sections for FAQs and advanced details." path: /04/content/containers/collapsible/ file: concepts/04-content-containers-collapsible.md locale: en version: 04 tags: - id: 04-content-containers type: concept title: "Custom Containers" description: "A gallery of the rich UI components available in docmd." path: /04/content/containers/ file: concepts/04-content-containers.md locale: en version: 04 tags: - id: 04-content-containers-nested-containers type: concept title: "Nested Containers" description: "Learn how to use the advanced nested container system to create complex, interactive documentation layouts with seamless container nesting." path: /04/content/containers/nested-containers/ file: concepts/04-content-containers-nested-containers.md locale: en version: 04 tags: - id: 04-content-containers-steps type: concept title: Steps description: "Create beautiful numbered instruction lists for tutorials." path: /04/content/containers/steps/ file: concepts/04-content-containers-steps.md locale: en version: 04 tags: - id: 04-content-containers-tabs type: concept title: Tabs description: "Organise content into switchable tabbed panes." path: /04/content/containers/tabs/ file: concepts/04-content-containers-tabs.md locale: en version: 04 tags: - id: 04-content-frontmatter type: concept title: "Frontmatter Reference" description: "The complete guide to page-level metadata and configuration in docmd." path: /04/content/frontmatter/ file: concepts/04-content-frontmatter.md locale: en version: 04 tags: - id: 04-content-live-preview type: concept title: "Live Preview & Browser Support" description: "Run docmd entirely in the browser without a server using the new Live architecture." path: /04/content/live-preview/ file: concepts/04-content-live-preview.md locale: en version: 04 tags: - id: 04-content-no-style-example type: concept title: "docmd : No-Style Page Example" description: "An example of a page using the no-style feature" path: /04/content/no-style-example/ file: concepts/04-content-no-style-example.md locale: en version: 04 tags: - id: 04-content-no-style-pages type: concept title: "No-Style Pages" description: "Create landing pages and custom layouts by disabling the default docmd theme." path: /04/content/no-style-pages/ file: concepts/04-content-no-style-pages.md locale: en version: 04 tags: - id: 04-content-syntax-advanced type: concept title: "Advanced Syntax" description: "Beyond the basic syntax, docmd supports a variety of advanced Markdown features to help you create richer documentation." path: /04/content/syntax/advanced/ file: concepts/04-content-syntax-advanced.md locale: en version: 04 tags: - id: 04-content-syntax-code type: concept title: "Code Blocks" description: "How to display code with syntax highlighting, line numbers, and copy buttons." path: /04/content/syntax/code/ file: concepts/04-content-syntax-code.md locale: en version: 04 tags: - id: 04-content-syntax-images type: concept title: "Images & Lightbox" description: "Adding images, galleries, and enabling lightbox zoom effects." path: /04/content/syntax/images/ file: concepts/04-content-syntax-images.md locale: en version: 04 tags: - id: 04-content-syntax type: concept title: "Markdown Syntax" description: "Basic formatting guide for docmd: Headings, lists, bold, italic, and more." path: /04/content/syntax/ file: concepts/04-content-syntax.md locale: en version: 04 tags: - id: 04-content-syntax-linking type: concept title: "Linking & Referencing" description: "A guide to internal cross-linking, external links, and asset referencing." path: /04/content/syntax/linking/ file: concepts/04-content-syntax-linking.md locale: en version: 04 tags: - id: 04-contributing type: concept title: Contributing description: "Learn how you can contribute to the development, design, and documentation of docmd." path: /04/contributing/ file: concepts/04-contributing.md locale: en version: 04 tags: - id: 04-deployment type: concept title: "Deployment (Deploy Your Website)" description: "Learn how to deploy your docmd-generated static site to modern hosting platforms like GitHub Pages, Vercel, and Netlify." path: /04/deployment/ file: concepts/04-deployment.md locale: en version: 04 tags: - id: 04-getting-started-basic-usage type: concept title: "Basic Usage" description: "A quick-start guide to initialising a project, writing content, and building your site." path: /04/getting-started/basic-usage/ file: concepts/04-getting-started-basic-usage.md locale: en version: 04 tags: - id: 04-getting-started-installation type: concept title: Installation description: "How to install docmd globally or locally using npm, yarn, or pnpm." path: /04/getting-started/installation/ file: concepts/04-getting-started-installation.md locale: en version: 04 tags: - id: 04 type: concept title: "docmd: The Minimalist Docs Generator" description: "Generate beautiful, lightweight, and blazing-fast documentation sites directly from your Markdown files. Zero clutter, just content." path: /04/ file: concepts/04.md locale: en version: 04 tags: - id: 04-plugins-analytics type: concept title: "Analytics Integration Plugin" description: "Integrate web analytics services like Google Analytics into your docmd site to track visitor traffic." path: /04/plugins/analytics/ file: concepts/04-plugins-analytics.md locale: en version: 04 tags: - id: 04-plugins-building-plugins type: concept title: "Building Plugins" description: "A guide for developers on how to create and share custom docmd plugins." path: /04/plugins/building-plugins/ file: concepts/04-plugins-building-plugins.md locale: en version: 04 tags: - id: 04-plugins-llms type: concept title: "LLM Support (llms.txt) Plugin" description: "Generate context files for Large Language Models (AI) to better understand your documentation." path: /04/plugins/llms/ file: concepts/04-plugins-llms.md locale: en version: 04 tags: - id: 04-plugins-mermaid type: concept title: "Mermaid Diagrams Plugin" description: "Create beautiful diagrams and flowcharts using Mermaid syntax in your docmd documentation." path: /04/plugins/mermaid/ file: concepts/04-plugins-mermaid.md locale: en version: 04 tags: - id: 04-plugins-search type: concept title: "Search Plugin" description: "Configure the offline-capable, full-text search engine." path: /04/plugins/search/ file: concepts/04-plugins-search.md locale: en version: 04 tags: - id: 04-plugins-seo type: concept title: "SEO & Meta Tags Plugin" description: "Configure Search Engine Optimisation (SEO) meta tags to improve your docmd site's discoverability." path: /04/plugins/seo/ file: concepts/04-plugins-seo.md locale: en version: 04 tags: - id: 04-plugins-sitemap type: concept title: "Sitemap Plugin" description: "Automatically generate a sitemap.xml for your docmd site to improve search engine discoverability." path: /04/plugins/sitemap/ file: concepts/04-plugins-sitemap.md locale: en version: 04 tags: - id: 04-plugins-usage type: concept title: "Extending docmd with Plugins" description: "Extend docmd's functionality with built-in integrations." path: /04/plugins/usage/ file: concepts/04-plugins-usage.md locale: en version: 04 tags: - id: 04-recipes-custom-fonts type: concept title: "Recipe: Adding Custom Fonts" description: "Personalize your documentation by importing Google Fonts." path: /04/recipes/custom-fonts/ file: concepts/04-recipes-custom-fonts.md locale: en version: 04 tags: - id: 04-recipes-favicon type: concept title: "Recipe: Adding a Custom Favicon" description: "How to add a custom favicon to your documentation site." path: /04/recipes/favicon/ file: concepts/04-recipes-favicon.md locale: en version: 04 tags: - id: 04-recipes-landing-page type: concept title: "Recipe: Creating a Landing Page" description: "How to build a custom landing page using noStyle." path: /04/recipes/landing-page/ file: concepts/04-recipes-landing-page.md locale: en version: 04 tags: - id: 04-recipes-writing-guide type: concept title: "Recipe: Documentation Writing Guide" description: "Best practices for writing clear, scannable, and effective documentation with docmd." path: /04/recipes/writing-guide/ file: concepts/04-recipes-writing-guide.md locale: en version: 04 tags: - id: 04-theming-assets-management type: concept title: "Assets Management" description: "Learn how to manage and customise your assets (CSS, JavaScript, images) in your docmd site." path: /04/theming/assets-management/ file: concepts/04-theming-assets-management.md locale: en version: 04 tags: - id: 04-theming-available-themes type: concept title: "Available Themes" description: "An overview of the built-in themes provided by docmd." path: /04/theming/available-themes/ file: concepts/04-theming-available-themes.md locale: en version: 04 tags: - id: 04-theming-custom-css-js type: concept title: "Custom Styles & Scripts" description: "Learn how to add your own custom CSS and JavaScript to your docmd site for advanced customisation." path: /04/theming/custom-css-js/ file: concepts/04-theming-custom-css-js.md locale: en version: 04 tags: - id: 04-theming-customisation type: concept title: "Customisation & Variables" description: "Master the look of your docs by overriding CSS variables and targeting component classes." path: /04/theming/customisation/ file: concepts/04-theming-customisation.md locale: en version: 04 tags: - id: 04-theming-icons type: concept title: Icons description: "How to use and customise Lucide icons in your documentation." path: /04/theming/icons/ file: concepts/04-theming-icons.md locale: en version: 04 tags: - id: 04-theming-light-dark-mode type: concept title: "Light & Dark Mode" description: "How to configure and manage light and dark themes in your docmd documentation." path: /04/theming/light-dark-mode/ file: concepts/04-theming-light-dark-mode.md locale: en version: 04 tags: