QRISM

LLM 协作维护的 Markdown Wiki：规范 + CLI + 发布方案。 英文: README.md

QRISM 是一套端到端的知识库工具链：一个 git repo = 一个自洽的 wiki，由人和 LLM Agent 协作编辑，然后发布为带图谱导航和间隔复习进度的静态站。

基于 Karpathy 的 LLM Wiki 模式 —— 把源料蒸馏成长青笔记、用 wikilink 互联、把缺口暴露成 TODO。

特色

• 一 repo 一知识库 —— 根目录的 QRISM.md 规范让多个 Agent（和人）跨会话保持一致
• 力导向图谱作为主导航 —— Obsidian 风格画布、前置依赖解锁链、答题门
• 静态站输出 —— 纯 HTML/JS 产物，零服务端，可部署到 GitHub Pages / Netlify / Vercel / S3
• 可在 Obsidian 中编辑 —— 整个仓库即 Obsidian vault（适配 Obsidian）
• 富 Markdown 渲染 —— 代码高亮 / LaTeX 数学 / Mermaid 图 / 图片嵌入开箱即用
• 递进式学习 —— 节点状态（锁定 / 已解锁 / 已完成 / 待复习）从 YAML frontmatter 的 requires: 链推导
• 多端适配 —— 桌面分栏，手机单栈

安装

npm install -g @qnroa/qrism
# 或
pnpm add -g @qnroa/qrism

需要 Node ≥ 20。

快速开始

# 1. 新建 wiki
qrism repo new my-wiki --description "我的知识库"
cd my-wiki

# 2. 写内容 —— 任何 Markdown 编辑器都行
#    （Obsidian、VS Code、Claude Code 等）
echo "# 欢迎" > wiki/welcome.md

# 3. 校验链接 / requires / 循环
qrism check

# 4. 本地预览
qrism publish build
qrism publish serve

# 5. 配置 CI（默认 GitHub Pages）
qrism publish init --ci github
git init && git add -A && git commit -m "init"
git push -u origin main

命令

| 命令 | 作用 | |---|---| | qrism repo new <name> | 新建一个 wiki 仓库（含 QRISM.md、示例页、配置） | | qrism init | 给已有目录补齐 QRISM 规范文件 | | qrism check | 校验链接、requires 路径、依赖循环 | | qrism publish build | 构建静态站到 dist/ | | qrism publish serve [-p PORT] | 本地预览 dist/ | | qrism publish init --ci github | 生成 .github/workflows/qrism.yml |

每个命令 qrism <cmd> --help 看完整选项。

仓库结构

my-wiki/
├── QRISM.md               # 规范 —— 让 LLM 保持一致
├── qrism.config.json      # 站名、解锁模式、CI 目标
├── wiki/
│   ├── basics/foo.md
│   └── advanced/bar.md
├── raw/                   # 原始源料（PDF、截图……）
│   └── 2026-06-13-paper.pdf
└── dist/                  # `publish build` 产物，gitignore

每个 wiki/**/*.md 页面带 YAML frontmatter：

---
title: Foo
topic: basics
requires:
  - ./prereq-page.md
---

# Foo

正文支持 [[Wikilink]]、$\LaTeX$、```mermaid 图。

文档

给用户：

• CLI 完整参考 —— 每个命令，每个 flag
• 发布流水线 —— qrism publish build 产出什么
• 私有 repo / 国内访问 —— Cloudflare + 腾讯云 EdgeOne 双站方案
• Obsidian 适配 —— 必装插件、Front Matter Title 配置

给维护者和贡献者：

• 贡献指南 —— 本地开发、测试、PR 流程
• 发布流程 —— 怎么发新版
• 架构总览 —— core / cli / view 怎么分工

规范全文：templates/zh/QRISM.md（中文）/ templates/en/QRISM.md（英文）。qrism repo new --lang zh|en 时拷成用户仓库的 QRISM.md。

文档索引：docs/README.zh.md（中文）/ docs/README.md（English）。

License

Apache-2.0 —— 详见 LICENSE。