看源码的第一步，我猜很多人搞错了~

大家好，我是若川。

今天在江西人的前端群里，有个小伙伴问，vueuse 的 vitepress （也就是官方文档仓库）怎么搭建的，怎么都没有 index.json（引用的一个文件）。

本文简单记录下流程，供大家学习参考。

我当时用 github1s.com 打开 https://github1s.com/vueuse/vueuse 看了下，推荐TA看 README.md 和 贡献文档。果然，然后我在 package.json 等文件中找到命令。会生成 index.json 文件。

贡献文档 pnpm install && pnpm dev

命令

update 命令

生成 index.json

相对开源项目写源码来说，看其源码其实不算难。

如果把学习看做是爬山，爬山并没有我们想象中的那么难。

但可能：

• 难在我们徘徊不前，找不到山的入口。
• 难在我们爬山路上没有同伴。
• 难在可能没有相对好走的路。
• 难在我们不能坚持爬到山顶。
• 难在我们不知道为何要爬山。
• 等等。

假设我们要把某个项目跑起来，第一步肯定是看 README.md 和贡献文档。然后看 package.json 相应的命令和文件结构，把项目跑起来。后续再调试等。再根据情况查阅搜索资料等，这一系列操作下来就学到不少东西。而这些基本操作，我在源码共读中的辅助文章都基本写过。只是学的人比较少，或者说迟迟没有踏出第一步。又或者说因为不知道为啥要“爬山”，所以不“爬山”。

比如可能很多小伙伴对于上面的截图。monorepo、nr 是啥，esno 又是啥等等。

关于 nr 之前我写过文章《尤雨溪推荐神器 ni ，能替代 npm/yarn/pnpm ？简单好用！源码揭秘！》。其实就是 @antfu/ni 库，其实就是 npm/yarn/pnpm run 一种简写，也是源码共读中的一期。

esno 简单来说是跑 ts 文件的。

感兴趣的小伙伴，可以找个比较有名自己常用的，比如vue-cli、create-vite、create-vite、create-react-app、vue、react、taro、element、vant 等。看看TA的README.md 、贡献文档和 package.json一些依赖的库、命令和入口文件等，你可能会发现多学几个之后发现都类似。学习的过程中有问题可以在各种交流群提问讨论，而不是利用交流群划水聊太多无关的。学完可以输出一篇文章。

总结，今天主要分享了如何找到爬山的入口，真正去爬山。第一步肯定是看 README.md 和贡献文档。然后看 package.json 相应的命令和文件结构，把项目跑起来。

希望今天的分享对你有所收获。