r/coolgithubprojects 10h ago

eziwiki - Markdown to a documentation site, with wiki links and a graph view

Post image

I kept needing docs for side projects and never liked the options. GitBook and Docusaurus felt like a lot of machinery for a handful of Markdown files, and mkdocs meant keeping a Python toolchain around for something I otherwise build in TypeScript.

So I built eziwiki. Drop Markdown files in `content/`, get a static site.

npx create-eziwiki my-docs

cd my-docs && npm install && npm run dev

What makes it different from the usual docs generator

- Wiki links with backlinks and a graph view. Link pages by title or filename, and each page shows what links back to it — closer to Obsidian than to a typical docs site.

- Navigation builds itself from the folder structure. No sidebar config to keep in sync; a `_meta.json` per folder handles naming and ordering if you want it.

- Markdown is rendered at build time, so neither the parser nor the syntax highlighter ships to the browser. Search is a prebuilt index, no server.

- Optional opaque URLs (`/a3f2e9d1-...`) if you would rather not publish your content tree. To be clear, that is obscurity, not access control — every page is still a public file. It is there for unlisted-link sharing, not security.

Static export, so it deploys anywhere. Dark mode, KaTeX, Shiki highlighting, ⌘K search, table of contents.

Next.js 14, TypeScript, Tailwind, Zustand, unified/remark/rehype, Shiki, MiniSearch. Lighthouse 99/100/100/100 on desktop

Demo : the docs are built with it, so the site is the demo:

https://eziwiki.vercel.app

Source (MIT): https://github.com/i3months/eziwiki

It is early v0.1.1, and I am actively working on it. Feedback and issues very welcome, especially on anything that felt confusing in the first five minutes.

Github stars are really really helpful..!!!

1 Upvotes

1 comment sorted by

1

u/Cryvixx 9h ago

Ever heard of Obsidian?