Quickstart

Getting started•3 min read||

Create a documentation site and preview it locally in under 3 minutes.

Set your project name:

Scaffold a new documentation project:

npx docslit init {{PROJECT}}

This creates a / directory with a starter configuration and three example pages.

cd {{PROJECT}}

npx docslit dev

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:

" open>

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)

Create docs/guides.md:

--- title: Guides --- # Guides Welcome to the guides section. <wc-callout type="info" title="Coming soon"> More guides are on the way. </wc-callout>

Open docslit.json and add "guides" to the pages array:

{ "name": "{{PROJECT}}", "sidebar": [ { "group": "Getting Started", "pages": ["introduction", "installation", "quickstart", "guides"] } ] }

The dev server picks up the config change automatically. Your new page appears in the sidebar.

When you are ready to deploy, build a static site:

npx docslit build

This creates a dist/ directory with everything you need to deploy. See static hosting for deployment guides.