Documentation powered by Pagesmith

A fully featured documentation site with search, series navigation, and custom layout overrides -- built entirely from configuration and markdown.

Get Started View on GitHub

npm install @pagesmith/docs

Features

Filesystem-First

Your content directory structure becomes your site navigation. Drop markdown files in folders and Pagesmith does the rest.

Schema-Validated

Frontmatter is validated with Zod schemas at build time. Catch errors before they reach production.

Built-In Search

Pagefind integration provides instant client-side search with zero backend configuration.

Layout Overrides

Customize any layout by providing your own JSX components in a theme directory.

Series Navigation

Group related pages into ordered series with previous/next navigation for guided reading.

Static Output

Produces plain HTML files deployable to any static host -- GitHub Pages, Netlify, Vercel, or a file server.

Packages

@pagesmith/docs

Convention-based docs with search, navigation, frontmatter validation, and layout overrides.

0.10.0Docs

@pagesmith/core

Shared content layer, markdown pipeline, validators, and Vite content integrations that power the docs package.

0.10.0Core

Quick Start

{
  name: 'Pagesmith',
  title: 'Example Docs',
  contentDir: './content',
  outDir: '../../gh-pages/examples/doc-site',
  basePath: '/pagesmith/examples/doc-site',
  theme: {
    layouts: {
      home: './theme/layouts/DocHome.tsx',
      page: './theme/layouts/DocPage.tsx',
    },
  },
  search: { enabled: true, showSubResults: true },
}

Welcome to Example Docs

This site is the @pagesmith/docs package example: config-first (pagesmith.config.json5), markdown in content/, section meta.json5 for sidebars and series, optional JSX layout overrides, and Pagefind search wired by the docs build.

Explore

Guide — install, dev/build/preview/MCP, project layout, meta.json5, layouts, search, and how @pagesmith/core backs the markdown pipeline.
Configuration — the same options as this repo’s pagesmith.config.json5, explained field-by-field.
Kitchen sink — single markdown regression page for this example’s rendered output.