Your first 5 minutes#

This hands-on tutorial walks through the smallest useful PreactPress workflow. Follow the steps below in your project — this starter already includes the finished result.

1. Change the site title#

Edit .preactpress/config.ts:

export default {
  site: {
    title: "My Docs",
    description: "Short summary for search and social previews",
  },
};

Save the file. The dev server picks up config changes on the next request.

2. Add a page#

Create about.md:

---
title: About
description: About this site
---

# About us

Your content here.

PreactPress serves it at /about. Every .md or .mdx file under srcDir (default: project root) becomes a URL automatically.

Example: news/2025/intro.md → /news/2025/intro.

This starter already includes About so you can see the finished page.

3. Add it to the navigation#

In .preactpress/config.ts:

export default {
  site: { title: "My Docs" },
  themeConfig: {
    nav: [
      { text: "Home", link: "/" },
      { text: "About", link: "/about" },
    ],
    sidebar: [
      {
        text: "Guide",
        items: [
          { text: "Home", link: "/" },
          { text: "About", link: "/about" },
        ],
      },
    ],
  },
};

Save — the dev server hot-reloads your changes.

Next steps#

Before deploying, set site.url in config for canonical URLs, Open Graph tags, and sitemap.xml. Read the package README for routing, MDX, deployment, and custom theme details.