# DocsLit

> Documentation for DocsLit — build beautiful docs with Markdown and web components

> Raw Markdown for each page is available at https://docs.docslit.com/0.1/{slug}.md

## Getting started

- [Introduction](https://docs.docslit.com/0.1/getting-started/introduction.md): DocsLit is a documentation framework that combines Markdown with interactive web components — no build tools, no JSX, no imports.
- [Why DocsLit](https://docs.docslit.com/0.1/getting-started/why-docslit.md): How DocsLit compares to React-based documentation tools like Docusaurus, Nextra, and Mintlify on bundle size, build speed, and authoring experience.
- [Installation](https://docs.docslit.com/0.1/getting-started/installation.md): Install DocsLit and set up your development environment to start building documentation sites.
- [Quickstart](https://docs.docslit.com/0.1/getting-started/quickstart.md): Create and preview a DocsLit documentation site in under 3 minutes with a single command.
- [Project structure](https://docs.docslit.com/0.1/getting-started/project-structure.md): Understand the file and folder layout of a DocsLit project, including docslit.json, the docs directory, and build output.

## Writing content

- [Markdown basics](https://docs.docslit.com/0.1/writing-content/markdown-basics.md): Learn the Markdown syntax supported by DocsLit, including headings, lists, links, images, and GFM extensions.
- [Reusable content](https://docs.docslit.com/0.1/writing-content/reusable-content.md): Create shared Markdown snippets and include them across multiple pages to keep content consistent and maintainable.
- [Variables and precedence](https://docs.docslit.com/0.1/writing-content/variables-and-precedence.md): Use inline variables in your docs that readers can edit, with cascading precedence rules for defaults and overrides.
- [Frontmatter](https://docs.docslit.com/0.1/writing-content/frontmatter.md): Configure page metadata like title, description, tags, and layout using YAML frontmatter at the top of each Markdown file.
- [Pages and navigation](https://docs.docslit.com/0.1/writing-content/pages-and-navigation.md): Organize your documentation with sidebar groups, page ordering, and navigation links in docslit.json.
- [Search and SEO](https://docs.docslit.com/0.1/writing-content/search-and-seo.md): Built-in full-text search, sitemap generation, meta tags, and AI agent discovery with llms.txt for every DocsLit site.

## Components

- [Callouts and alerts](https://docs.docslit.com/0.1/components/callouts-and-alerts.md): Highlight important information with callout and alert components for tips, warnings, errors, and notes.
- [Code blocks](https://docs.docslit.com/0.1/components/code-blocks.md): Display syntax-highlighted code with copy buttons, filenames, line numbers, code groups, and theme toggles.
- [Tabs and accordions](https://docs.docslit.com/0.1/components/tabs-and-accordions.md): Organize content into switchable tabs and collapsible accordion sections to reduce page length.
- [Cards and tiles](https://docs.docslit.com/0.1/components/cards-and-tiles.md): Create clickable card grids and compact tile layouts for navigation, feature highlights, and link collections.
- [Steps](https://docs.docslit.com/0.1/components/steps.md): Present sequential instructions as numbered steps with titles and rich content for tutorials and guides.
- [Layout](https://docs.docslit.com/0.1/components/layout.md): Structure page content with columns, panels, frames, expandable sections, and floating aside boxes.
- [API reference components](https://docs.docslit.com/0.1/components/api-reference-components.md): Document API endpoints with parameter fields, response schemas, runnable request builders, and method badges.
- [Data display](https://docs.docslit.com/0.1/components/data-display.md): Render tables, key-value lists, color swatches, and Mermaid diagrams from structured data in your docs.
- [AsciiDoc tables](https://docs.docslit.com/0.1/components/asciidoc-tables.md): Author rich tables with AsciiDoc syntax — column specs, spans, alignment, cell styles, CSV/DSV, and more.
- [File trees](https://docs.docslit.com/0.1/components/file-trees.md): Display interactive file and directory trees with icons, highlighting, and collapsible folders.
- [Interactive elements](https://docs.docslit.com/0.1/components/interactive-elements.md): Add buttons, tooltips, badges, copy-to-clipboard prompts, and other interactive elements to your documentation.
- [Icons](https://docs.docslit.com/0.1/components/icons.md): Use built-in Lucide icons and Font Awesome brand icons by name in any DocsLit component or inline.

## Customization

- [Theming](https://docs.docslit.com/0.1/customization/theming.md): Choose a color preset, define a corporate brand theme, and control dark/light mode for your DocsLit site.
- [Logo](https://docs.docslit.com/0.1/customization/logo.md): Replace the default favicon in the navigation bar with your own logo image.
- [Site chrome](https://docs.docslit.com/0.1/customization/site-chrome.md): Navbar links, footer, custom CSS, head tags, analytics, favicon, and basePath
- [Internationalization](https://docs.docslit.com/0.1/customization/i18n.md): Locale directories, switcher, and hreflang
- [Announcement banner](https://docs.docslit.com/0.1/customization/announcement-banner.md): Display a dismissible site-wide banner at the top of your docs for product updates, launches, and important notices.
- [Custom components](https://docs.docslit.com/0.1/customization/custom-components.md): Build your own web components with Lit or vanilla JS and use them alongside the built-in DocsLit components.
- [Versioning](https://docs.docslit.com/0.1/customization/versioning.md): Serve multiple documentation versions side by side with branch-based versioning and a version selector.

## Deployment

- [Static hosting](https://docs.docslit.com/0.1/deployment/static-hosting.md): Deploy your DocsLit site as static files to Netlify, Vercel, Cloudflare Pages, GitHub Pages, or any CDN.
- [Chapter PDF export](https://docs.docslit.com/0.1/deployment/chapter-pdf-export.md): Generate chapter, page, and full-documentation PDFs at build time with docslit build --pdf, and let readers download them from your site.
- [Offline builds](https://docs.docslit.com/0.1/deployment/offline-builds.md): Generate a self-contained documentation site that works offline, from a file:// URL, or on air-gapped networks — with no external dependencies.
- [DocsLit Cloud](https://docs.docslit.com/0.1/deployment/docslit-cloud.md): Publish your documentation instantly with DocsLit Cloud — managed hosting with custom domains and automatic builds.

## Migration

- [From Mintlify](https://docs.docslit.com/0.1/migration/from-mintlify.md): Migrate your Mintlify documentation project to DocsLit with a single command that converts MDX to Markdown.
- [From Fern](https://docs.docslit.com/0.1/migration/from-fern.md): Migrate your Fern documentation project to DocsLit with automatic component and configuration conversion.
- [From GitBook](https://docs.docslit.com/0.1/migration/from-gitbook.md): Migrate your GitBook documentation to DocsLit with automatic content and structure conversion.

## Integrations

- [OpenAPI integration](https://docs.docslit.com/0.1/integrations/openapi.md): Generate API reference documentation from an OpenAPI 3.x spec with automatic parameter extraction, response schemas, and sidebar hierarchy
- [AI Skills](https://docs.docslit.com/0.1/integrations/skills.md): Install DocsLit skills into your AI agent so it can write correct docslit markup and migrate existing docs

## CLI reference

- [Commands](https://docs.docslit.com/0.1/cli-reference/commands.md): Complete reference for all DocsLit CLI commands including dev, build, init, import, publish, and validate.
- [Validation](https://docs.docslit.com/0.1/cli-reference/validation.md): Run docslit validate to check for broken links, missing assets, invalid components, and other project issues.

## Changelog

- [What's new](https://docs.docslit.com/0.1/changelog/whats-new.md): Latest features, improvements, and fixes in DocsLit releases.