大家好,我是若川。
今天在江西人的前端群里,有個小伙伴問,vueuse
的 vitepress
(也就是官方文檔倉庫)怎么搭建的,怎么都沒有 index.json
(引用的一個文件)。
本文簡單記錄下流程,供大家學習參考。
我當時用 github1s.com
打開 https://github1s.com/vueuse/vueuse
看了下,推薦TA看 README.md
和 貢獻文檔
。果然,然后我在 package.json
等文件中找到命令。會生成 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
相應的命令和文件結構,把項目跑起來。
希望今天的分享對你有所收獲。