WikidownWikidown

A wiki that lives in /docs.

Wikidown is an opinionated, tool-supported wiki you commit alongside your code. A strict format spec keeps docs consistent whether you edit in the browser, from the CLI, or through an AI agent — no backend, no extra service to operate.

Open the editor View on GitHub

Getting started

Add Wikidown to any repo in two commands — no .NET installation required either way.

Using an AI coding agent

Just ask it

Paste this into Claude Code, Copilot, or any agent with terminal access:

Install Wikidown from wikidown.org and run wikidown init in this repo.

It picks the right install path itself, drops in a wiki skill/subagent (Claude Code) or agent/chat-mode (Copilot), and seeds docs/Home.md — nothing to configure by hand.

From a terminal

Two commands

# If you have dotnet installed:
dotnet tool install -g Wikidown.Cli
wikidown init
# If not — installs a self-contained CLI, no .NET required:
curl -fsSL https://wikidown.org/install.sh | sh      # Windows: irm https://wikidown.org/install.ps1 | iex
wikidown init

Either way the binary is wikidown and init behaves identically.

How it works

1. Connect a repo

Sign in with GitHub, or connect a GitLab or Azure DevOps repo with a PAT. Pick the repo and branch that holds your /docs folder. Tokens stay in the browser.

2. Browse & edit

Title-form links, .order files, and subpages — all enforced by the Wikidown spec. Edit in a side-by-side markdown editor with live preview.

3. Commit via REST

Save commits directly to your repo through the host's REST API. File-level conflict detection keeps concurrent edits safe.

Publish it with GitHub Pages

One command turns /docs into a Jekyll site GitHub builds for you — no pipeline, no hosting bill.

Scaffold, push, flip a switch

wikidown pages
git add docs && git commit -m "Publish wiki" && git push
# GitHub → Settings → Pages → main, /docs

Drops a _config.yml tuned for the Wikidown format — relative .md links rewritten, titles from headings, .attachments served — into the wiki folder.

Starter theme with a real nav tree

A left navigation that follows your .order files, active page highlighted, sections collapsible, responsive on phones. Styled like this page; it's plain CSS and Liquid in your repo, so restyle it however you like.

The tree is data (_data/navigation.yml) the CLI and MCP server regenerate on every change, so it never drifts from the wiki. Not on GitHub? wikidown export-html --output public renders the same theme in .NET — no Jekyll, no Ruby — for GitLab Pages, Azure Static Web Apps, or any static host.

Built for humans and agents

Ship the same /docs wiki from a terminal, an MCP host, or a prebuilt agent config.

CLI

wikidown

Reads, writes, moves, reorders, and searches pages while keeping .order consistent. The install script auto-detects .NET — no runtime required either way.

curl -fsSL https://wikidown.org/install.sh | sh
wikidown list
wikidown new "/Getting Started/Format"
MCP server

wikidown-mcp

Stdio MCP server for Claude Code, Claude Desktop, or VS Code (Copilot). Nine tools cover the full read/write surface.

dotnet tool install -g Wikidown.Mcp
# wire into .mcp.json or .vscode/mcp.json
Agent configs

Drop-in

One shared Agent Skills SKILL.md for Claude Code and GitHub Copilot, plus subagent, custom agent, and chat-mode wiring — installed by one command.

curl -fsSL https://wikidown.org/install.sh | sh
wikidown init --agents all

Format

Wikidown enforces a simple, opinionated format so your docs stay consistent whether a human or an AI agent is editing them. The full spec is in the docs: