Repolode
提交项目
i3months

i3months/eziwiki

基于 Next.js 的 Markdown 知识库与文档生成器，支持搜索、双向链接和图谱视图，输出为静态文件。

在 GitHub 查看官网
Star
112
Fork
14
未关闭 Issue
4
最近提交
5天前

这是什么？

EziWiki 可以把一个目录下的 Markdown 文件生成为静态知识库网站。content/ 下的每个 .md 文件都会自动成为页面，文件夹则对应侧边栏的分区，除非需要手动控制命名和排序，否则无需配置导航数组。

它覆盖了知识库常见的需求：浏览器内全文搜索、构建时解析的 [[页面名]] 形式双向链接、页面和章节的嵌入引用、反向链接、标签，以及展示页面关联关系的 /graph 图谱页。Markdown、Shiki 代码高亮、KaTeX 数学公式和 Mermaid 图表都在构建阶段完成渲染，浏览器无需加载 Markdown 解析器。

输出结果是纯静态 HTML，可以部署到 Vercel、Netlify 或 GitHub Pages。项目还自带链接检查命令，可以找出失效链接、孤立页面，以及已被引用但尚未编写的页面。

核心功能

  • 01content/ 中的文件会自动发布，文件夹形成侧边栏分区。
  • 02浏览器内全文搜索，覆盖标题、各级小节和页面正文。
  • 03双向链接支持按文件名、标题或路径解析，失效链接会被标出。
  • 04反向链接和全站图谱视图展示页面之间的关系。
  • 05页面可以嵌入其他页面或章节，也可嵌入 PDF 和图片。
  • 06Mermaid 图表、KaTeX 公式和带行高亮的代码块均在构建时渲染。
  • 07支持标签、旧路径别名，以及根据 git 历史生成的最后更新时间。

适用场景

  • 将 Markdown 笔记发布为个人数字花园或知识库。
  • 搭建内部团队文档，并支持链接和搜索。
  • 为项目创建可部署为静态文件的 Wiki。
  • 维护相互链接的技术笔记，并在 CI 中检查失效链接。

快速上手

  1. 1

    创建新项目

    npx create-eziwiki my-docs
  2. 2

    进入项目文件夹

    cd my-docs
  3. 3

    安装依赖

    npm install
  4. 4

    启动开发服务器并打开 http://localhost:3000

    npm run dev

使用前须知

  • 需要 Node.js 22.13 或更高版本。
  • 1.0 之前的版本中，配置项、frontmatter 字段或设置可能在发布间变化，升级需要手动复制引擎目录。

收录于专题

静态网站生成器与文档工具

标签

#markdown#wiki#static-site-generator#documentation#knowledge-base#digital-garden#nextjs#graph-view#backlinks#docs-generator

常见问题

eziwiki 是什么？
基于 Next.js 的 Markdown 知识库与文档生成器，支持搜索、双向链接和图谱视图，输出为静态文件。 EziWiki 可以把一个目录下的 Markdown 文件生成为静态知识库网站。content/ 下的每个 .md 文件都会自动成为页面，文件夹则对应侧边栏的分区，除非需要手动控制命名和排序，否则无需配置导航数组。
eziwiki 可以免费使用吗？用的什么许可证？
eziwiki 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
eziwiki 还在维护吗？
活跃维护中。eziwiki 最近一次提交是在 2026年11月2日。
eziwiki 适合用来做什么？
将 Markdown 笔记发布为个人数字花园或知识库。 搭建内部团队文档，并支持链接和搜索。 为项目创建可部署为静态文件的 Wiki。 维护相互链接的技术笔记，并在 CI 中检查失效链接。
eziwiki 怎么安装和运行？
创建新项目: npx create-eziwiki my-docs 进入项目文件夹: cd my-docs 安装依赖: npm install 启动开发服务器并打开 http://localhost:3000: npm run dev
在哪里获取 eziwiki？
源代码和安装说明在 GitHub 上：https://github.com/i3months/eziwiki

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目