Skip to Content

Quick Start

Create a docs site with Fumapress on Waku.

Fumapress turns your Markdown files into a complete docs site on Waku. It is built on Fumadocs and comes with layouts, search, SEO files and plugins. Custom pages and layouts are React Server Components.

Creating a Site

Create the Project

npm create fumapress -- --framework waku

Start the Dev Server

From the new folder:

npm run dev

The project looks like this:

index.mdx
app.css
press.config.tsx
vite.config.ts

Write a Page

Each file under content/ is a page. Add one:

content/hello.mdx
---
title: Hello
description: My second page.
---

## Overview

It is available at `/hello`, and listed in the sidebar.

Learn more in Content.

Name the Site

Set the name in press.config.tsx. It shows in the navbar and page metadata.

press.config.tsx
export default createPress(docs.toFumadocsSource()).config({
  site: {
    name: "My Docs", 
  },
});

Next Steps

Moving an existing site? See Upgrade to Fumapress 2 or Migrate from Mintlify.

In the samples of these docs, content and docsSource stand for your content sources, and the import of createPress is left out.

Last updated on

On this page