Getting Started

Install lildocs, build your first static docs site, and start the local development server.

Run lildocs directly with pnpm dlx:

pnpm dlx lildocs@0.1.x ./docs

Or add it to a project:

pnpm add -D lildocs

Then call it from package scripts:

{
  "scripts": {
    "docs:build": "lildocs build ./docs",
    "docs:dev": "lildocs dev ./docs"
  }
}

Build A Site

The shortest build command is:

lildocs ./docs

This treats ./docs as the docs root, finds a home page, generates navigation from the folder structure, builds a local search index, copies assets, and writes the site to dist.

Use the explicit build subcommand when a script or CI job should make the intent obvious:

lildocs build ./docs

If the input path points to a Markdown file, that file becomes the home page and its parent folder becomes the docs root:

lildocs ./docs/index.md

The output is self-contained. Page links are relative, local assets are copied into the output folder, and search-index.json is generated next to the HTML files.

Preview Locally

Use the development server while writing:

lildocs dev ./docs

The dev server writes generated files to .lildocs by default and serves them through Vite from 127.0.0.1:3000. Add --open to launch the preview in your default browser.

Choose a different output folder when you want to inspect the generated files:

lildocs dev ./docs --out ./.docs-preview

Choose the host or port when the defaults conflict with another local service:

lildocs dev ./docs --host 0.0.0.0 --port 4173

The dev output directory must stay inside the current workspace, cannot be the repository root, and cannot contain the docs root.

To explore a random light/dark theme pair and complementary font combination, start a shuffled preview:

lildocs shuffle ./docs --open

Run it again for another combination, or add --save to keep the selected theme and fonts in config.json.

Next Steps

Read Writing content and Navigation and page structure to organize your docs. Then explore local search, Mermaid diagrams, and the generated API reference, or use the CLI reference and configuration reference for option details.