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 Claude Code

Just ask it

Paste this into Claude Code at the root of your repo:

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

It installs the CLI, seeds docs/Home.md, and adds a wikidown skill, a wikidown-editor subagent, and a wiki section in CLAUDE.md. See Claude Code Integration.

Using GitHub Copilot

Just ask it

Paste this into Copilot agent mode in VS Code:

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

It installs the CLI, seeds docs/Home.md, and adds repo instructions, a wikidown custom agent, and a chat mode — also used by the coding agent on github.com. See GitHub Copilot Integration.

Using Muse

Give it a wiki to remember in

Paste this into a new Muse side chat:

Install wikidown from wikidown.org using the terminal curl command for their install script. Then generate a new SSH keypair and show me the public key.

Add that public key as a deploy key on the repo (Settings → Deploy keys, with write access). Then paste this, with your repo's address in place of the example:

Clone https://github.com/you/your-repo using that SSH key. From now on, whenever a decision, preference, or fact worth keeping comes up while we work, write it to the wiki in that repo's docs folder using wikidown, then commit and push the change.

Two Muse accounts can share one wiki, too — see Muse Integration.

From a terminal

Two commands

# Installs a self-contained CLI, no .NET required:
curl -fsSL https://wikidown.org/install.sh | sh
wikidown init
# Windows (PowerShell):
irm https://wikidown.org/install.ps1 | iex
wikidown init
# Or, if you have the .NET SDK installed:
dotnet tool install -g Wikidown.Cli
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 regenerates 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 AI coding agent, 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 --path Getting-Started/Format
Export

PDF and HTML

One linked PDF with cover, contents, and bookmarks, or the starter theme rendered as static HTML for any host. Same renderer in the CLI, Visual Studio, and the browser editor.

wikidown export-pdf --output wiki.pdf
wikidown export-html --output public
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: