Repolode
i3months

i3months/eziwiki

A Markdown wiki and documentation generator built on Next.js, with search, wiki links, backlinks and a graph view, output as static files.

Stars
112
Forks
14
Open issues
4
Last commit
5 days ago

What is it?

EziWiki turns a folder of Markdown files into a static wiki site. Each .md file under content/ becomes a published page, and folders become sidebar sections, so no navigation array is required unless you want manual control over naming and order.

The project covers the features a wiki usually needs: full-text search in the browser, wiki links such as [[page name]] that resolve at build time, transclusion of other pages or sections, backlinks, tags, and a /graph page showing how pages connect. Markdown, code highlighting with Shiki, KaTeX maths and Mermaid diagrams are all rendered during the build, so no Markdown parser ships to the browser.

The output is plain static HTML and can be deployed to Vercel, Netlify or GitHub Pages. The project includes a link checker that reports broken links, orphan pages and pages that are linked to but not yet written.

Key features

  • 01Files in content/ are published automatically, with folders forming sidebar sections.
  • 02Full-text search runs in the browser and indexes headings and page contents.
  • 03Wiki links resolve by file name, title or path, and broken links are flagged.
  • 04Backlinks and a site-wide graph view show how pages relate.
  • 05Pages can embed other pages or sections, and PDFs and images.
  • 06Mermaid diagrams, KaTeX maths and code blocks with line highlighting are rendered at build time.
  • 07Tags, aliases for moved pages, and last-updated dates taken from git history.

Use cases

  • Publishing a personal digital garden or knowledge base from Markdown notes.
  • Building internal team documentation that is linked and searchable.
  • Creating a project wiki that can be deployed as static files.
  • Maintaining a linked set of technical notes with a check for broken links in CI.

Quick start

  1. 1

    Create a new project

    npx create-eziwiki my-docs
  2. 2

    Enter the project folder

    cd my-docs
  3. 3

    Install dependencies

    npm install
  4. 4

    Start the dev server and open http://localhost:3000

    npm run dev

Things to know

  • Requires Node.js 22.13 or higher.
  • Before version 1.0, configuration keys, frontmatter fields or settings may change between releases, and updating means manually copying engine directories.

In collections

Topics

FAQ

What is eziwiki?
A Markdown wiki and documentation generator built on Next.js, with search, wiki links, backlinks and a graph view, output as static files. EziWiki turns a folder of Markdown files into a static wiki site. Each .md file under content/ becomes a published page, and folders become sidebar sections, so no navigation array is required unless you want manual control over naming and order.
Is eziwiki free to use? What license does it have?
eziwiki is open source under the MIT license. Check the license terms before using it in commercial products.
Is eziwiki still maintained?
Actively maintained. The last commit to eziwiki was on Nov 2, 2026.
What can I use eziwiki for?
Publishing a personal digital garden or knowledge base from Markdown notes. Building internal team documentation that is linked and searchable. Creating a project wiki that can be deployed as static files. Maintaining a linked set of technical notes with a check for broken links in CI.
How do I install eziwiki?
Create a new project: npx create-eziwiki my-docs Enter the project folder: cd my-docs Install dependencies: npm install Start the dev server and open http://localhost:3000: npm run dev
Where can I get eziwiki?
The source code and installation instructions are on GitHub: https://github.com/i3months/eziwiki

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects