The Markdown Wiki — empower the team with sharing your knowledge.

Crowi is a Markdown Wiki for team knowledge sharing. URL paths are the page hierarchy, so /team/handbook/onboarding reads exactly the way it's written. v2 ("Reignite") rebuilds the frontend from Express + Swig + jQuery to Next.js 16 (App Router) + React 19 + ts-rest 3, while keeping v1's MongoDB data shape intact — your existing wiki migrates over.

This repository is a Turborepo + pnpm workspace.

crowi/
├── apps/
│   └── crowi-site/        # crowi.wiki LP + docs (Next.js + Fumadocs, port 4303)
├── crowi.config.json      # Dev runner config: plugins + active driver names
├── .env.example           # Dev runtime env template (copy to .env)
└── packages/
    ├── api/                          # Express 4 + ts-rest 3 API library (port 4301)
    ├── api-contract/                  # Shared ts-rest contracts + Zod schemas
    ├── web/                           # Next.js 16 frontend (port 4302)
    ├── runner/                        # Config loader + plugin resolver (used by @crowi/api boot)
    ├── plugin-api/                    # Plugin SDK (CrowiPlugin / registries / context)
    ├── plugin-aws/                    # Shared AWS credentials base plugin
    ├── plugin-storage-local/          # Default-on local FS storage driver
    ├── plugin-storage-aws-s3/         # S3 storage driver
    ├── plugin-search-elasticsearch/   # Elasticsearch search driver
    ├── plugin-renderer-emoji/         # `:emoji:` → 🎉 renderer
    ├── plugin-renderer-katex/         # KaTeX math renderer
    ├── plugin-renderer-plantuml/      # PlantUML diagram renderer
    ├── plugin-renderer-crowi-legacy/  # v1-era wikilinks / strikethrough / etc.
    └── admin-cli/                     # `crowi-admin` CLI (init / migrate / re-encrypt)

The API package is plugin-agnostic at runtime — @crowi/runner resolves plugin npm names against the runner project's node_modules/ via createRequire(<projectDir>/package.json). Operators add a plugin by declaring it in their runner's package.json deps and listing it in crowi.config.json:plugins; the api never needs to be rebuilt.

• API: Express 4 + ts-rest 3 + Mongoose + JWT auth (jwtAuth middleware)
• Web: Next.js 16 (App Router, Turbopack) + React 19 + Tailwind CSS v4 + shadcn/ui + @tanstack/react-query
• Site: Next.js 16 (static export) + Fumadocs UI + i18n (ja / en)
• Shared: TypeScript 5.x strict, pnpm workspaces, Turborepo
• Lint / Format: Biome (format) + ESLint (lint), lefthook hooks
• Tests: Jest + supertest + mongodb-memory-server (API)

• Node.js 22.x
• pnpm 8.x or later
• MongoDB
• Redis
• Elasticsearch (optional, plugin-driven)
• Docker / Docker Compose (for local infrastructure)

# 1. Install dependencies
pnpm install

# 2. Start dependency services (MongoDB / Redis / Elasticsearch / PlantUML)
docker compose up -d

# 3. Set up env file at the repo root (loaded by the api at boot via dotenv)
cp .env.example .env
# Edit MONGO_URI / REDIS_URL / PASSWORD_SEED / CROWI_ENCRYPTION_KEY etc.

# 4. Run everything (api on :4301, web on :4302, plugins compiled in watch mode)
pnpm dev

Other targeted scripts:

pnpm dev:api       # just the API + plugins (no Next.js)
pnpm dev:web       # just the Next.js frontend
pnpm dev:site      # crowi.wiki LP + docs (port 4303)

.env.example (at the repo root) lists the full set. Highlights:

Storage backend selection is driven by the runner's crowi.config.json (storage.driver: 'local' | 's3' | ...) plus the corresponding @crowi/plugin-storage-* package — there is no FILE_UPLOAD env any more.

pnpm test                                  # all apps
pnpm --filter @crowi/api test              # api only
pnpm type-check                            # api + web + site
pnpm lint                                  # all apps; errors=0 required
pnpm build                                 # all
pnpm --filter @crowi/api-contract build    # required after editing contracts

Format runs automatically via lefthook on commit (Biome). Manual: pnpm format / pnpm format:check.

Plugins are regular npm packages declared in the runner project's dependencies and listed in crowi.config.json:plugins. The shipped first-party plugins live under packages/plugin-*/:

• Storage: plugin-storage-local (default), plugin-storage-aws-s3
• Search: plugin-search-elasticsearch
• Renderers: plugin-renderer-emoji, plugin-renderer-katex, plugin-renderer-plantuml, plugin-renderer-crowi-legacy

Write your own by depending on @crowi/plugin-api, exporting a default CrowiPlugin, and adding the package name to your runner's crowi.config.json.

The MIT License (MIT). See LICENSE.