Quickstart
Create a documentation site and preview it locally in under 3 minutes.
Set your project name:
Scaffold a new documentation project:
This creates a {{PROJECT}}/ directory with a starter configuration and three example pages.
The dev server starts on http://localhost:3000 with hot reload enabled. Every time you save a file, the browser updates automatically.
Open docs/introduction.md in your editor and make a change. The browser reloads instantly to show your update.
What was created
After running init, your project looks like this:
| File | Purpose |
|---|---|
docslit.json | Project configuration — site name and sidebar structure |
docs/*.md | Your documentation pages in Markdown |
components/ | Directory for custom web components (optional) |
Add a new page
Create docs/guides.md:
Open docslit.json and add "guides" to the pages array:
The dev server picks up the config change automatically. Your new page appears in the sidebar.
Build for production
When you are ready to deploy, build a static site:
This creates a dist/ directory with everything you need to deploy. See static hosting for deployment guides.
Next steps
- Learn about project structure to understand how DocsLit organizes your content
- Read Markdown basics to start writing effective documentation
- Explore the components to add rich interactions to your pages