Code前端首页关于Code前端联系我们

Vue3离线文档哪里下载最靠谱 全平台无网络也能看

terry 57分钟前 阅读数 14 #Vue

最近好多刚接触Vue3或者经常出差赶现场、坐长途火车开发的小伙伴问我,有没有好用的全平台Vue3离线文档?毕竟开发时搜问题卡网速、或者连不上网就抓瞎,总不能抱着手机热点硬刷吧?我特意整理了自己踩过坑之后筛选出的几个靠谱渠道,还有怎么用更顺手的小技巧,看完应该能解决你90%以上的离线Vue3需求。

官方渠道是首选?是的但要搞对版本和格式

很多人可能第一反应去官方找,但官方Vue3的中文离线文档入口藏得有点深,而且不同版本格式可能不一样,新手容易下载错,官方有三个主流版本的离线资源:纯静态HTML版、VSCode插件版、Zeal/Dash集成版,每个版本适配不同场景,先说说各自怎么搞。

纯静态HTML版完全不用额外装工具,解压后双击index.html就能用浏览器打开,不管是Windows、Mac还是Linux,甚至平板的Chrome浏览器也行,不过官方没有直接在中文Vue3首页放下载链接,得去GitHub仓库找——找到Vue3的官方中文文档仓库,别找英文的哦,里面有个Releases板块,每次更新中文文档都会同步打包成zip和tar.gz压缩包,压缩包里就包含完整的静态文件,这里要注意Releases里的标签,最新稳定版的标签会带个Latest标识,别下载那些Pre-release的测试版,测试版有时候会有内容缺失或者链接打不开的情况,我上个月帮朋友找的时候,测试版的组合式API语法高亮示例少了好几个,差点耽误事,纯静态版有个小缺点,就是搜索功能不如在线版或者插件版智能,只能搜关键词的精确匹配或者部分模糊匹配,比如搜“响应式数据”只能出标题或者正文里带这个完整短语的内容,搜“ref和reactive区别”也只能挨个翻结果,不能像在线版那样直接定位到对比表格,不过胜在不用装任何东西,带个U盘拷到任何电脑都能用,应急性拉满。

VSCode插件版适合平时用VSCode开发Vue3的小伙伴,不用离开编辑器就能查文档,效率特别高,这个插件叫“Vue - Official”,是Vue官方团队维护的,除了语法高亮、代码补全这些基础功能,还内置了完整的Vue3中文离线文档,安装方法很简单,打开VSCode的扩展商店,搜索Vue - Official,选那个带蓝色对勾、下载量超过1000万的,别下错第三方的,安装好之后怎么用呢?首先确保插件是最新版本,然后按Ctrl+Shift+P(Mac是Cmd+Shift+P)调出命令面板,输入“Vue: Open Documentation”,就能直接打开内置的离线文档面板了,这个面板的搜索功能非常智能,和在线版几乎一模一样,支持模糊搜索、语义搜索,比如搜“watch监听props要不要加deep”,能直接跳转到Watch选项的详细说明和常见示例里,还有个更方便的小技巧,写代码的时候如果忘了某个API的用法,比如写了个ref()但是不知道怎么绑定DOM元素,只需要把鼠标悬停在ref上,插件就会弹出一个小提示框,里面有这个API的基础用法,点击提示框里的“查看更多”按钮,就能直接跳转到离线文档的对应位置,不过VSCode插件版也有个局限,就是只能在VSCode里用,如果你用的是WebStorm、Sublime Text这些其他编辑器,就只能选别的版本了。

Zeal/Dash集成版是跨编辑器的全功能离线文档首选,Zeal是Windows和Linux版的,Dash是Mac版的,都是免费开源的文档浏览器,除了Vue3之外,还能集成JavaScript、TypeScript、Node.js、Element Plus等几乎所有主流前端技术的离线文档,相当于一个“前端离线百科全书”,先说说怎么安装和配置Zeal吧,Windows用户可以去官网直接下载安装包,Linux用户可以用apt-get或者yum安装,Mac用户如果不想花钱买Dash(虽然Dash的界面和交互更好,但免费版的Zeal完全够用),也可以用Crossover或者Wine运行Zeal的Windows版,安装好之后,打开Zeal,点击左侧菜单栏的“Docsets”,然后点击右下角的“Available”,在搜索框里输入“Vue.js”,会出来好几个结果,要选那个带中文标识的“Vue.js 3 (中文)”,别选英文的或者Vue.js 2的,选好之后点击右下角的“Download”,下载速度取决于你的网速,不过一般几十兆的文档包,几分钟就能下完,下载好之后,“Vue.js 3 (中文)”就会出现在左侧菜单栏的“Installed”里,点击就能打开,Zeal/Dash的搜索功能比VSCode插件版还要好用,支持全文搜索、标签搜索,还能设置快捷键,比如我设置的是按F1直接打开Zeal/Dash,搜完按ESC就能关闭,完全不打断开发思路,而且Zeal/Dash的文档包更新频率和官方中文文档同步,每次打开Zeal/Dash的时候,都会自动检查有没有更新,如果有更新的话,会在左侧菜单栏的“Vue.js 3 (中文)”旁边显示一个小红点,点击就能一键更新。

第三方渠道的离线文档能用吗?要慎重筛选

除了官方渠道之外,网上也有很多第三方整理的Vue3离线文档,比如百度网盘、GitHub个人仓库、前端博客网站打包下载的,这些第三方离线文档能用吗?我的建议是能不用就不用,除非你特别信任那个整理者,或者官方渠道暂时下载不了,为什么这么说呢?因为第三方整理的离线文档可能有几个问题:第一是内容不完整,可能缺了最新版本的API更新或者常见问题解答;第二是内容有错误,有些整理者可能自己对Vue3的理解有问题,会把错误的内容加进去;第三是可能带广告或者病毒,有些第三方网站打包的压缩包里会偷偷放弹窗广告插件或者恶意软件,解压之后会影响电脑的安全;第四是版权问题,虽然Vue3的官方文档是开源的,但有些第三方整理者会把自己的广告或者个人信息加进去,甚至收费下载,这是违反开源协议的。

不过也不是所有第三方渠道的离线文档都不能用,比如有些GitHub上的前端大佬,会整理一份“Vue3核心API离线速查手册”或者“Vue3+TypeScript最佳实践离线文档”,这些都是大佬自己根据官方文档和实战经验整理的,内容更精炼、更实用,适合进阶学习的小伙伴,怎么找这些靠谱的第三方离线文档呢?第一是去GitHub的Trending板块找,Trending板块里的仓库都是最近比较火的,一般不会有问题;第二是看仓库的Star数和Fork数,Star数超过1000的、Fork数超过100的,一般都是比较靠谱的;第三是看仓库的README文件,README文件里会写清楚整理者的身份、整理的内容、更新时间、有没有广告或者病毒;第四是看仓库的Issues和Pull Requests,Issues里有没有人反馈内容有错误或者缺失,Pull Requests多不多,说明整理者会不会定期更新。

全平台适配的Vue3离线文档小方案

刚才说的三个官方渠道里,纯静态HTML版是全平台适配的,但搜索功能不太好用;VSCode插件版只能在VSCode里用;Zeal/Dash集成版虽然全平台,但Mac用户如果不用Crossover或者Wine的话,只能花钱买Dash,那有没有一个既全平台适配、又搜索功能好用、还免费的Vue3离线文档小方案呢?我自己折腾了一个,分享给大家。

这个小方案的核心是用纯静态HTML版的官方中文文档,加上一个第三方的静态搜索插件Algolia DocSearch的本地版,或者用VuePress自带的本地搜索插件重打包,先说说用Algolia DocSearch本地版的方法,不过这个方法稍微有点复杂,需要一点前端开发基础,首先去GitHub仓库下载最新稳定版的Vue3中文静态文档压缩包,解压之后会看到一个vuepress/dist文件夹,这个就是完整的静态网站文件,然后去Algolia DocSearch的官方网站申请一个免费的API密钥,不过这个API密钥是用于在线搜索的,要改成离线搜索的话,得先把Vue3中文文档的所有内容爬下来,生成一个索引文件,然后用Algolia DocSearch的本地版JS库加载这个索引文件,爬文档生成索引文件可以用Algolia提供的免费工具DocSearch Scraper,不过需要配置一下docker-compose.yml文件,稍微有点麻烦,新手可能搞不定。

那新手可以用什么方法呢?可以用VuePress自带的本地搜索插件重打包,这个方法稍微简单一点,但也需要安装Node.js环境,首先去Node.js的官方网站下载最新稳定版的Node.js安装包,安装好之后打开命令行工具(Windows是CMD或者PowerShell,Mac是Terminal),输入node -v和npm -v检查是否安装成功,如果显示版本号的话,说明安装成功了,然后去GitHub仓库克隆Vue3中文文档的源码仓库,注意是源码仓库,不是Releases里的压缩包,源码仓库的名字是vuejs/docs-next-zh-cn,克隆好之后进入仓库根目录,输入npm install安装依赖,安装依赖的速度可能有点慢,可以用npm config set registry https://registry.npmmirror.com/切换到淘宝镜像源,然后再输入npm install,安装好依赖之后,打开仓库根目录的.vuepress/config.js文件,找到plugins配置项,里面默认是开启Algolia DocSearch在线搜索的,把Algolia DocSearch的配置注释掉,然后加上VuePress自带的本地搜索插件的配置,本地搜索插件的配置很简单,就一行代码:['@vuepress/search', { searchMaxSuggestions: 10 }],配置好之后,输入npm run docs:build重打包静态文档,打包好之后会在仓库根目录生成一个新的vuepress/dist文件夹,这个文件夹里的静态文档就自带本地智能搜索功能了,和在线版的几乎一模一样,然后把这个新的dist文件夹打包成zip压缩包,拷到U盘里,不管是Windows、Mac还是Linux,甚至平板的Chrome浏览器,双击index.html就能用,搜索功能也非常好用。

离线开发Vue3还要准备什么?

除了离线文档之外,离线开发Vue3还要准备一些其他的东西,不然还是会抓瞎,首先是Vue3的项目模板,虽然官方的Vue CLI和Vite都支持创建项目,但离线状态下是创建不了的,因为需要从npm仓库下载依赖,所以可以提前用Vite创建几个常用的Vue3项目模板,比如Vue3+JavaScript、Vue3+TypeScript、Vue3+TypeScript+Element Plus、Vue3+TypeScript+Pinia+Vue Router,然后把项目里的node_modules文件夹和package-lock.json/yarn.lock文件一起打包成zip压缩包,拷到U盘里,离线状态下创建项目的时候,只需要把对应的压缩包解压,然后用编辑器打开就能用了,不用再下载依赖,不过要注意,node_modules文件夹的体积比较大,一般几百兆甚至上G,所以要准备一个容量大一点的U盘,或者用压缩率比较高的压缩格式,比如7z。

然后是常用的Vue3插件和库的离线安装包,比如Element Plus、Pinia、Vue Router、Axios、Lodash这些,可以提前用npm pack命令把它们的最新稳定版打包成tgz压缩包,拷到U盘里,离线状态下安装的时候,只需要在项目根目录输入npm install 插件或库的tgz压缩包路径,就能安装了,比如要安装Element Plus的离线包,只需要把element-plus-x.x.x.tgz拷到项目根目录,然后输入npm install element-plus-x.x.x.tgz,就能安装成功了。

自己整理的Vue3实战笔记和代码片段,实战笔记和代码片段比官方文档更实用,因为都是自己在开发过程中踩过坑、总结出来的,可以用Markdown格式整理实战笔记,用VSCode的Snippets功能整理代码片段,然后把它们一起打包成zip压缩包,拷到U盘里,离线状态下遇到问题的时候,先翻自己的实战笔记和代码片段,找不到的话再翻离线文档,这样效率会更高。

Vue3离线文档最靠谱的渠道是官方渠道,纯静态HTML版应急性拉满,VSCode插件版适合用VSCode开发的小伙伴,Zeal/Dash集成版是跨编辑器的全功能首选,第三方渠道的离线文档要慎重筛选,除非特别信任整理者,如果想要一个既全平台适配、又搜索功能好用、还免费的Vue3离线文档,可以用VuePress自带的本地搜索插件重打包官方源码,除了离线文档之外,离线开发Vue3还要准备项目模板、常用插件和库的离线安装包、自己整理的实战笔记和代码片段,希望这篇文章能帮到大家,让大家在无网络的情况下也能顺利开发Vue3项目。

版权声明

本文仅代表作者观点,不代表Code前端网立场。
本文系作者Code前端网发表,如需转载,请注明页面地址。

热门