Skip to content

Each repository can host a wiki — a separate collection of Markdown pages for documentation that lives alongside the code without being mixed into it.

  1. Open the repository and select Settings.
  2. Under Features, turn on Wiki.
  3. A Wiki tab appears in the repository navigation.
  1. Select the Wiki tab.
  2. If the wiki has no pages yet, select Create the First Page. Otherwise, select New Page.
  3. Enter a page title. The title becomes the page’s URL, so choose something clear and stable.
  4. Write the content in Markdown, then select Save Page.

The first page you create becomes the wiki’s Home — the page visitors land on by default. To update an existing page, open it and select Edit. Every save records a new entry in the page’s revision history.

Two specially named pages control navigation across the whole wiki:

  • _Sidebar — a custom sidebar shown on every page. Add links to your most important pages here.
  • _Footer — a footer shown at the bottom of every page.

Create either one from New Page using the exact name shown above. Link between wiki pages with standard Markdown, referencing the page slug:

See the [Setup Guide](setup-guide) for installation steps.

Use descriptive page titles from the start: the title becomes the URL, and renaming a page later breaks any existing links to it.

The wiki is itself a Git repository, available at the .wiki.git URL for your repository. Clone it, edit the Markdown files in your editor, and push the changes back.

Terminal window
git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

The same personal access token you use for the main repository works here. Each Markdown file becomes a wiki page; the filename (without the .md extension) is the page slug.