Quick Start

Prerequisites#

• Node.js 18 or newer
• Basic familiarity with Markdown

Step 1: Create a wiki#

npx create-eziwiki my-docs

This scaffolds a complete project — engine, config, and two starter pages.

Prefer to work from the repository itself? See Installation.

Step 2: Install and run#

cd my-docs
npm install
npm run dev

Open http://localhost:3000.

Step 3: Write a page#

Create content/notes/first.md:

---
title: My First Page
description: This is my first wiki page
order: 1
---

# My First Page

Welcome to my wiki!

Save it. The page appears in the sidebar under a Notes section — no config change, no restart. That is the whole workflow: a file is a page.

Step 4: Name the section#

The folder became a section called "Notes". To label or order it, add content/notes/_meta.json:

{
  "name": "📓 Notes",
  "order": 1,
  "color": "#dbeafe"
}

See Navigation Configuration for the full set of options.

Step 5: Link pages together#

See [[first]] for the basics.

Wiki links resolve by file name, full path, or page title, so you can link without knowing where a page sits. The target page automatically gains a backlink at its bottom. See Wiki Links.

Step 6: Make it yours#

Edit payload/config.ts:

export const payload: Payload = {
  global: {
    title: 'My Awesome Wiki',
    description: 'My personal knowledge base',
    baseUrl: 'https://mywiki.com',
  },
};

Set baseUrl before publishing — canonical URLs, the sitemap, and social previews all use it. See Payload Configuration and Theme Customization.

Step 7: Build#

npm run build

A fully static site lands in out/. Deploy it anywhere — see Static Export.

Commands#

npm run dev              # Development server
npm run build            # Static production build
npm run start            # Preview the production build

npm run show-urls        # List every page and its URL
npm run check:links      # Report unresolved links and pages worth writing
npm run new <path>       # Create a page, frontmatter and all
npm run validate:payload # Check the config

npm run lint             # ESLint
npm run format           # Prettier
npm test                 # Test suite

Next#

• Markdown Basics — what a page can contain
• Frontmatter — per-page settings
• Search — how readers will find things