Getting Started

This guide walks you through setting up a Solidocs site from scratch.

Requirements

Install the package:

pnpm add solidocs

You will also need solid-js in your project:

pnpm add solid-js

A minimal Solidocs site looks like this:

my-site/
├── solidocs.config.ts
├── package.json
└── docs/
    ├── index.md
    └── guide/
        ├── getting-started.md
        └── config.md

Every .md file becomes a page. guide/getting-started.md is served at /guide/getting-started.html.

Create a solidocs.config.ts:

import { defineConfig } from "solidocs"

export default defineConfig({
  title: "My Site",
  description: "My site description",
  basePath: "/",
})

See the configuration guide for all options.

Start the dev server with live reload:

pnpm docs:dev

Generate the static site into .solidocs/dist:

pnpm docs:build

The output is fully static — deploy it to any static host or GitHub Pages.