生产力
splitting-notes avatar

splitting-notes

将单一庞大的笔记文件重构为模块化、具备索引导航的结构,适合处理超过 1000 行的笔记以提升可读性与组织性。

简介

splitting-notes 是一项系统性的重构技能,专为维护和优化大型文档存储库而设计。当 Markdown 文件过大(超过 1000 行)或因主题混杂而难以阅读时,该技能可透过渐进式分组原则将庞大的内容拆解为模块化、专注于单一主题的文件(目标约 500 行),并生成具备层级导航的索引文件。此过程能显著降低认知负荷、提升检索效率,并改善网站生成的构建性能。

  • 自动识别大型 H2 章节,将其提取为独立文件。

  • 根据特定规则构建索引文件,格式为: - Name - Description。

  • 强制执行严格的 Frontmatter 标准,包括 sidebar_position 与 tags。

  • 支持多步骤重构工作流程,要求进入 Plan Mode 以确保结构完整性。

  • 迁移后会自动更新文件内部的链接参考并修正资源路径(如图片路径)。

  • 与 pnpm build、Lint 工具链及 Grep 检测整合,确保迁移后的文件质量。

  • 在执行拆分前,务必先调用 EnterPlanMode 以规划迁移策略。

  • 非常适合技术文档、个人知识库或学习笔记(TIL)的管理。

  • 输入要求:现有的 Markdown 文件需具备结构明确的 H2 标题。

  • 输出结果:整洁的模块化目录结构以及作为目录页的专用索引文件。

  • 限制条件:不要拆分低于 500 行的文件,确保主题分组的连贯性,并在完成前务必执行 pnpm lint:content 进行验证。

仓库统计

Star 数
49
Fork 数
8
Open Issue 数
0
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 17:40
在 GitHub 查看