@dsh-external/xiashuo
虾说 — DSH 通用课程编写插件:九阶段门禁式编写流程 + 出题/试卷生成 + 知识图谱可视化 + 课程资料库注入 + 本地资料导入 + AI 一键润色 + 去AI味 + 教案诊断,开箱即用。
安装
$
npx -p @deepseek-ai/dsh dsh plugin --profile web add github:bettermen/xiashuo说明文档
阅读完整 README ↗🎯 使用场景
| 场景 | 怎么做 |
|---|---|
| 从零写一门新教材 | 打开工坊 → 「+新建」→ 选课程类型 → 逐章编写 |
| 已有大纲/知识点 | 建好课程后,把知识点录入资料库,正文引用 |
| 团队协作编教材 | 「分享」生成可编辑链接,多人协作 + 冲突检测 |
| 交付 Word 文档 | 「导出」→ Word(.docx) 一键下载 |
| 查看知识结构 | 右栏「知识图谱」可视化知识点关联 |
📖 功能使用指南
1️⃣ 新建课程
- 顶部「+新建」→ 弹窗输入课程名 + 下拉选课程类型(23 类分组)→ 创建
2️⃣ 编写章节(CodeMirror 编辑器)
- 左栏章节列表点击切换章节;中栏为 CodeMirror 6 Markdown 编辑器
- Markdown 语法高亮(标题、加粗、斜体、删除线、引用、列表、链接、行内代码、代码块)
- 软换行;列表 / 块引用按回车自动续行;引号与括号自动配对
- 支持撤销 / 重做、查找替换、行号显示
- 章节名可自定义(顶部输入框)
- 保存:手动点「保存」,或停止输入 2 秒自动保存(底部显示「● 未保存 / ✓ 已保存」)
- 搜索面板来自 CodeMirror 官方组件,面板文案为英文;快捷键 ⌘F 查找、⌘Z 撤销
2.5️⃣ 编辑器工具栏(手动排版)
中栏编辑器顶部有一条 Apple 风格工具栏,不用记 Markdown 语法也能手动排版,16 个按钮分 5 组:
- 历史:撤销 / 重做(⌘Z / ⇧⌘Z)
- 段落样式:正文 / 标题 H1–H3 / 引用 / 无序列表 / 有序列表 / 任务列表 / 代码块
- 行内:加粗 / 斜体 / 删除线 / 行内代码
- 外观:字体(默认 / 宋体衬线 / 黑体 / 等宽 / 楷体)+ 字体颜色(14 色)+ 文字高亮(8 色,可选"无")
- 插入:链接 / 图片 / 表格(6×8 网格,悬停预览行列)/ 分割线
- 视图:查找 / 行号开关
说明:
- 所有操作走一次撤销步(撤销即整段回退),并保持光标定位
- 字体颜色 / 高亮在 Markdown 中以内联 `` 落地(预览器白名单还原,仅放行安全的 CSS 属性,
url()/expression/javascript:一律拦截,内容可安全分享) - 颜色 / 高亮再次点击同色即取消;字体再次选择并入同一 span,不嵌套
2.6️⃣ 删除与拖拽排序
- 删除:悬停章节行 → 右侧浮现 ✕ 按钮;或在章节上右键 → 删除课时(二次确认后生效)
- 排序:直接拖动章节行到目标位置,落点显示蓝色插入条,松手即保存
- 右键菜单另有:预览 / 新建课时 / 复制标题
- 语义说明:
- 删除不重编号(保留稀疏编号,如删掉第 2 课后为 1、3),避免外部引用(分享链接、账本、AI 上下文)失效;新建课时取
max(no)+1,不会撞号 - 拖拽统一重编号为 1..N,并同步修正一致性账本的课时归属、按新顺序重放课程变量
- 两者都写入审计日志(
action: delete/reorder)
- 删除不重编号(保留稀疏编号,如删掉第 2 课后为 1、3),避免外部引用(分享链接、账本、AI 上下文)失效;新建课时取
3️⃣ 资料库(知识点)
- 右栏「资料库」Tab → 「+ 新建知识点」→ 填名称 / 内容 / 关键词(逗号分隔)
- 每条知识点支持预览 / 编辑 / 停用启用 / 删除
- 知识点按课程隔离
4️⃣ 知识图谱
- 右栏「知识图谱」Tab → 可视化当前课程知识点关联
- 节点标签防重叠,悬停查看完整名称
5️⃣ 导出
- 顶部「导出」→ 选 TXT 或 Word(.docx) → 直接下载
6️⃣ 分享协作
- 顶部「分享」→ 选权限(只读 / 可编辑)→ 生成链接 → 复制发给他人
- 可编辑协作:保存时带版本号,多人冲突时提示「覆盖 or 加载最新」
- 可撤销任意分享链接
⚙️ 配置
| 设置 | 默认 | 说明 |
|---|---|---|
| enabled | true | 插件总开关(关闭即注销工具/技能,数据保留) |
| dataDir | ~/.dsh/xiashuo | 数据根目录 |
| uiHidden | false | 隐藏侧边栏「虾说」入口 |