不知道大家有没有同感,在浏览一个项目的 README.md 时,特别看一些稍微硬核点的开源项目,那个文档长得简直像裹脚布。
找个参数配置,或者想跳到某个章节,要么鼠标把滚轮滚出火星,要么疯狂 Ctrl+F。
虽然 GitHub 自带目录,但不能随动,看着看着就不知道在哪了,体验真的很割裂,特别还有一些项目压根没有[TOC]。
实在忍不了了,周末搞了一次 Vibe Coding 实验。
目标很简单:让 GitHub 阅读体验丝般顺滑。
我就想做一个纯粹的、丝滑的侧边悬浮目录。
于是 github-markdown-toc-sidebar 诞生了。
没有花里胡哨的功能,只做一件事:帮你更好地阅读。
自动生成目录:解析 Head 1-Head 4 标题,结构清晰。
双模式自适应:
宽屏:完整的侧边栏( Sidebar ),放在内容右侧。
窄屏:自动变成悬浮小球( FAB ),不挡视线,点击展开。
智能高亮:滚动到哪,目录就亮到哪,随时知道自己在看啥。
Turbo 兼容:完美支持 GitHub 的页面跳转,点击链接目录秒更新,不用刷新。
这次开发过程非常 Chill ,OpenCode + Claude 一把撸。
有了 AI 之后,很多一直被“拖延”确想解决的“个人痛点”,被逐一去解决。
发现问题 -> 动手解决 -> 享受成果
开源在 GitHub:https://github.com/terranc/github-markdown-toc-sidebar
目前代码还在持续迭代中,商店审核中( Waiting...)。
大家可以直接 Clone 代码,用 Chrome 开发者模式加载[文件夹]安装扩展体验。
欢迎 Star ,欢迎 PR ,也欢迎提 Issue 吐槽~
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.