#Configuration

Solidocs is configured with a solidocs.config.ts file at your project root.

import { defineConfig } from "solidocs"

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

#Options

#title

The site title, used in the header and as the document title suffix.

#description

The site description, used on home pages and as the meta description fallback.

#basePath

Deploy under a sub path, useful for GitHub Pages:

export default defineConfig({
  basePath: "/my-repo/",
})

All routes and assets are prefixed with this path.

#themeConfig (header customization)

Customize the header — brand, logo and navigation links:

export default defineConfig({
  title: "Solidocs",
  themeConfig: {
    logo: "/img/logo.svg",      // brand image
    siteTitle: "My Docs",       // brand text; `false` hides it
    link: "/",                  // where the brand links to
    nav: [
      { text: "Guide", link: "/guide/getting-started/" },
      { text: "GitHub", link: "https://github.com/…" },
    ],
  },
})

Site-relative nav links are resolved against the base path. External links open in a new tab unless you pass an explicit target.

#Frontmatter

Each page supports frontmatter options:

#layout: home

Renders a hero section instead of the doc layout — no sidebar or outline. Use it for landing pages (index.md).

#Dark mode

The default theme ships with light/dark modes. The toggle in the header stores the choice in localStorage; by default the theme follows the visitor's system preference.

#Sitemap & 404

Generate a sitemap.xml during the build by setting a canonical origin and enabling the sitemap:

export default defineConfig({
  site: {
    url: "https://example.com", // no trailing slash
  },
  sitemap: true,
})

A 404.html is always emitted — most static hosts, GitHub Pages included, serve it for unknown paths. It renders the regular theme shell with a "page not found" message and a link back to the top.

#Syntax highlighting

Code blocks are highlighted with Shiki using the GitHub light/dark themes. Colors follow the active theme mode automatically — no configuration needed:

```ts
export const greet = (name: string) => `Hello, ${name}!`
```

#Page order

Set order in a page's frontmatter to control its position in the global navigation (sidebar, pager and home cards). Lower numbers come first; pages without order follow alphabetically after the ordered ones.

---
title: Configuration
order: 20
---

Tip: number pages in steps of 10 (10, 20, 30…). Inserting a new page between two others then only needs an unused value — say 15 — instead of renumbering everything. Fractional values (12.5) work too.