llm-wiki-compiler本地Viewer完全指南:知识图谱浏览、引用芯片与4大主题切换
【免费下载链接】llm-wiki-compilerThe knowledge compiler. Raw sources in, interlinked wiki out. Inspired by Karpathy's LLM Wiki pattern.项目地址: https://gitcode.com/gh_mirrors/ll/llm-wiki-compiler
llm-wiki-compiler(llmwiki)是一款"知识编译器"——原始资料进,互相链接的 Wiki 出。编译完成后,它的本地 Viewer是你与知识宝库对话的唯一窗口:llmwiki view一条命令,即可在浏览器中浏览知识图谱、通过**引用芯片(Citation Chips)**追溯每一条论断的出处,还能在4 大主题间一键切换。本指南面向新手,带你在 5 分钟内玩转这个完全离线、只读安全的本地 Viewer。
🚀 快速上手:一条命令启动本地 Viewer
安装只需一行(要求 Node.js 环境):
npm install -g llm-wiki-compiler在你的项目目录中,先编译 Wiki,再启动 Viewer:
llmwiki compile # 第一步:把原始资料编译成 Wiki 页面 llmwiki view --open # 第二步:启动本地服务并自动打开浏览器终端会打印:
Viewer ready at http://127.0.0.1:54321按Ctrl+C即可停止服务。常用参数一览:
| 参数 | 作用 |
|---|---|
--open | 启动后自动打开默认浏览器 |
--port <端口> | 指定固定端口(主题偏好按端口记忆) |
--host <IP> --allow-lan | 允许局域网访问(两者必须同时提供) |
💡 提示:Viewer 是只读的——它展示编译好的 Wiki 快照,不能写文件,所有修改都走 CLI 或 MCP 服务器,数据绝对安全。
🕸️ 浏览知识图谱:在 #/graph 发现概念之间的联系
打开地址栏中的#/graph路由,就是全功能的知识图谱浏览器。仪表板(#/)上还嵌有一张紧凑版迷你图谱,随时预览全局。
图谱的交互方式非常直觉:
- 悬停节点:显示该页面的标题、类型和连接数,其余节点自动变暗;
- 点击节点:直接打开对应 Wiki 页面;
- 滚轮缩放 / 拖拽平移:完整图谱里还能拖拽单个节点调整布局。
节点颜色一次只表达一个属性,语义清晰:
| 颜色含义 | 说明 |
|---|---|
| dangling(悬空) | 被链接指向但尚不存在的页面 |
| stale(过期) | 源文件已变化、需要重新编译(优先级高于类型) |
| concept / entity | 按页面类型区分 |
完整的图例面板会解释所有颜色、边类型和节点大小说义。图谱数据来自 src/viewer/graph.ts,想深入了解渲染实现可以阅读 src/viewer/ 目录。
🏷️ 引用芯片:让每一条论断都能追溯源头
这是本地 Viewer 最"硬核"的特性。编译时,llmwiki 会为每个段落的来源插入形如^[source.md]的标注,Viewer 把渲染成可点击的引用芯片:
- 悬停芯片:查看支撑该论断的原文段落;
- 点击芯片:打开源文件预览(
#/_source/<文件名>),高亮精确到行号区间——如field-notes.md:3-5,连 frontmatter 都算物理行; - 在
127.0.0.1本地访问时:芯片还附带"编辑器链接",一键在你的默认编辑器中跳转到源文件对应行,查证修改一气呵成。
芯片渲染逻辑在 src/viewer/citation-rule.ts 中实现。配合页面右侧的元数据栏(类型、贡献来源、置信度、时间戳)和新鲜度徽章(STALE/ORPHANED/CONTRADICTED),你的 Wiki 真正做到"证据就在身边"。
🎨 4大主题一键切换:从柔和陶土到霓虹星云
点击页面右上角的Theme选择器,即可在 4 个内置主题间即时切换——无需刷新、无需离开当前页面:
- Scientific Clay(默认):柔和的浅色陶土风格,圆润的字体与淡紫色表面,长时间阅读不累眼;
- Minimal (system):极简风,自动跟随操作系统浅色/深色设置;
- Nebula Light:星云浅色,明确的亮色选择;
- Nebula Dark:星云深色,夜猫子首选。
Scientific Clay 主题效果——注意段落旁的引用芯片field-notes.md:3-5与右上角的主题选择器:
Minimal 主题效果——同一页面切换为跟随系统的极简风格,布局与功能完全一致:
几个新手常见疑问:
- 主题会记住吗?会。偏好按浏览器来源(含端口)存储,键名为
llmwiki.viewer.theme.v1;旧版保存的light/dark会自动迁移到对应的 Nebula 主题。建议复用同一--port值保留偏好。 - 主题只改外观吗?是。4 个主题共享完全相同的布局、路由与图谱行为,只改变字体、配色和材质。
- 想自定义主题?官方支持新增内置调色板,参见 docs/guides/viewer-themes.mdx,每个主题的实现分别在 src/viewer/assets/themes/ 下的
scientific-clay.css、minimal.css、nebula.css。
🔍 其他值得一看的功能
- 全局搜索:页头搜索框支持
⌘K(Mac)/Ctrl+K快速聚焦,实时匹配所有编译页面的标题与正文; - 仪表板(
#/):四大计数器(概念数、来源数、需关注、待审核)+ 最近编译页面 + 建议的下一步操作; - 健康页(
#/health):按规则拆解 lint 问题,NEEDS ATTENTION或ALL CLEAR一句话给出全库裁决; - 待审队列(
#/reviews):查看候选页面被暂缓的原因芯片(低置信度、矛盾、schema 问题等)。
完整路由表见 docs/cli/view.mdx。
🔒 安全须知:为什么可以放心用
- 默认只绑定
127.0.0.1:Viewer 仅本机可访问,响应携带严格的同源 CSP,不会加载任何外部资源; - 只读设计:不能写入
sources/、wiki/或.llmwiki/,想修改请用 CLI; - 局域网模式需谨慎:
--host 192.168.1.10 --allow-lan会把全部页面内容暴露给局域网设备,且会屏蔽源文件字节(仅保留元数据与健康信息)。对外分享请改用llmwiki export导出静态产物; - 快照机制:除审查队列和工作流外,数据在启动时冻结——编译新页面后
Ctrl+C重启llmwiki view即可看到更新。
📚 延伸阅读
| 资料 | 路径 |
|---|---|
| View 命令完整文档 | docs/cli/view.mdx |
| 主题创建指南 | docs/guides/viewer-themes.mdx |
| Viewer 源码 | src/viewer/ |
| 快速上手 | docs/quickstart.mdx |
| 主题测试用例 | test/viewer/ |
从原始笔记到可交互的知识图谱,llmwiki 只需要两次回车。现在,打开你的终端,输入llmwiki view --open吧 🚀
【免费下载链接】llm-wiki-compilerThe knowledge compiler. Raw sources in, interlinked wiki out. Inspired by Karpathy's LLM Wiki pattern.项目地址: https://gitcode.com/gh_mirrors/ll/llm-wiki-compiler
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考