Introduction

Overview2 min read||

DocsLit is a documentation framework that combines Markdown with interactive web components. You write content in Markdown, drop in <wc-*> components for rich interactions, and deploy a fast static site — no build tools, no JSX, no imports.

Try it now

Set your project name:

npx docslit init {{PROJECT}} cd {{PROJECT}} npx docslit dev

Open http://localhost:3000 to see your site running locally.

How it works

DocsLit takes a different approach from tools that require JSX, MDX, or framework-specific syntax. You write standard Markdown and enhance it with HTML-native web components.

You write this:

<wc-callout type="tip" title="Quick start"> Run `npx docslit dev` to start. </wc-callout>

Your readers see this:

Run npx docslit dev to start.

No imports. No build step. No configuration. The components just work because they are standard web components rendered by the browser.

What you get

Every build generates a search index automatically. Your readers can find content instantly with the built-in search bar — no external service required. DocsLit respects system preferences and lets readers toggle between themes. Every component adapts automatically. Static builds produce individual HTML pages for search engines, sitemap.xml for crawlers, and llms.txt / llms-full.txt for AI agents. The dev server watches your files and reloads the browser instantly when you save. No manual refresh needed.

Next steps

Follow the installation guide to set up DocsLit on your machine. Walk through the quickstart to create and preview a documentation site in under 3 minutes. Browse the components section to see everything you can use in your docs.