Introduction

What is Fumapress?

Fumapress is a site generator powered by Fumadocs & Waku, as compared to Fumadocs, it manages more features such as routing, while being more opinionated.

It is perfect if you want a beautiful, flexible docs, without revealing too much complexity.

Since the app is still a Waku.js app, you can easily transition to a full Fumadocs app without heavy migration.

Getting Started

Automatic Installation

Create a new Fumapress app.

npm create fumapress

Manual Installation

Install the dependencies:

npm i waku fumapress fumadocs-ui fumadocs-core fumadocs-mdx react react-dom react-server-dom-webpack

npm i tailwindcss @tailwindcss/vite @types/react @types/react-dom typescript vite -D

Create the config files:

import { defineConfig } from "waku/config";
import tailwindcss from "@tailwindcss/vite";
import press from "fumapress/vite";
import mdx from "fumadocs-mdx/vite";

// the config file for Waku & Vite
export default defineConfig({
  vite: {
    plugins: [press(), mdx(), tailwindcss()],
  },
});

Add scripts:

{
  "scripts": {
    "dev": "waku dev",
    "build": "waku build",
    "start": "waku start",
    "types:check": "fumadocs-mdx && tsc --noEmit"
  }
}

Start the dev server:

npm run dev

You can now start writing Markdown files under the content directory.

---
title: My Page
description: Hello World
---

# Overview

This is my first document.

Learn More

Since Fumapress is based on Fumadocs, you can see the following for shared knowledge in authoring content with Fumadocs.