试试前些天尤老师提起的VitePress | 尝鲜记

前言

我们知道,前几天在杭州举办了第四届Vue.js开发者大会。会议中由vue的作者尤雨溪老师介绍了Vue 3生态的现状。

1.jpg

大概内容是,今年Vue开发者数量还是有比较大的增长,Vue 3周边库以及开发工具链都已经跟上了如Vuex4.0Vue Router 4.0以及QuasarElement PlusAnd Design VueVuetifyNuxt3等。script setupvolar 结合ts,使得SFCtemplate是有很不错的开发体验,而且计划 Q2 end Vue 3就会成为主版本;另外已经决定不在支持IE11Vue 2可以迁移到 @vue/compat或者等 v2.7版本。

具体详情可移步观看视频:

Vue.js作者尤雨溪在VueConf 2021谈Vue 3 生态进展

大家可能没太关注,其中他还提到VitePress,今天闲着先来尝尝鲜

image.png

什么是VitePress及其作用

引用尤雨溪的话:VitePress其实就是一个基于Vue3+Vite的静态站生成器

2.jpg

如果你之前用过VuePressHexoGatsby等静态站生成工具,可能很好理解,其实相当于VuePress,只是把Vue2换成Vue3,把webpack换成vite;如果你没有接触过,你就将它理解为:利用它可以搭建静态类网站,比如快速搭建博客或者文档等。其实偏向于文档,原因是VitePress旨在提供创作文档所需的最低限度的功能,正如作者所说,它是个弟弟

那为什么要用VitePress

换句话说它有什么优势?

其实优势也很明显,刚刚也说了,它相当于VuePress,当它将Vue2换成Vue3,把webpack换成vite,因此:

  1. 它有VuePress的所有优点;如:可以在md里面混合vue组件等;

  2. 具有Vite的速度;如:可以秒开一个VitePress开发服务器以及md的编辑也会瞬间更新

  3. 利用Vue3的一些高阶特性,做了一些更细致的优化;如避免纯静态内容的double payload(双重负载)和hydration开销

一句话小结:性能好

所以,如果你有新的项目要做文档或者搭建需要博客,可以试试VitePress

开始搭建

创建项目并初始化

yarn init
yarn add --dev vitepress

创建index.md文档doc目录下,可以在文档中写上hello VuePress,方便测查

添加以下脚本到package.json中

  "scripts": {
    "docs:dev": "vitepress dev docs",
    "docs:build": "vitepress build docs",
    "docs:serve": "vitepress serve docs"
  }

注意:是在package.json的大括号里面填充,即{要填充的代码}

启动服务

yarn docs:dev

出现以下代码表示搭建成功

3.jpg

进入页面

通过http://localhost:3000进入
结果如图所示:

4.jpg

默认没有配置的情况下,页面很简洁,图中只有我们写的hello VuePress。不妨填充一些内容,我将本文md内容copy到index.md中,显示如图

5.2.jpg

到这已经成功出来了,挺简洁的,是我喜欢的调调

但是怎么没有导航那些呢,应该是按需配置

创建配置

首先在 docs 目录下创建.vitepress 目录,然后开始设置配置;在.vitepress文件夹下创建config.js,它是配置 VitePress站的必要的文件,其将导出一个 JavaScript 对象:

module.exports = {
  title: 'Hello VitePress',
  description: 'A VitePress site.'
}

title表示页面标题

description渲染成页面的

<meta name="description" content="A VitePress site">

到这里的目录结果是这样子的

├─ docs
│  ├─ .vitepress
│  │  └─ config.js
│  └─ index.md
└─ package.json

另外需要注意:.vitepress需要用命令行命令进行创建,否则可能提示创建不了

window系统使用md命令

md config.js

其实我们需要关注,完整的选项配置列表。因为它关系到调整网页的结构和样式是不是想要的。但是刚刚看官网这部分还是404的状态。

也很正常,并且人家说的很明白

Note this is early WIP! Currently the focus is on making Vite stable and feature complete first. It is not recommended to use this for anything serious yet.

意思是,这个早期的WIP(可理解成在制品),目前主要精力专注于Vite的稳定和功能的完整,对于一些serious的事不建议使用它!

所以有些功能都还不完善,更别说文档,还中文文档。在当下的英文文档中,可以看到里面目前可用配置也很少。

image.png

所以还是敬请期待1.0或者更高版本发布吧

源码地址在这:vitepress

总结

  1. 整个体验过程还是很丝滑,特别是速度,如果写一些文档可以考虑。

  2. 待完善的一些功能,需要等,期待它的正式版本发布吧;

  3. 可以提个建议就是:如果你对VitePress感兴趣或者想参加开源,我觉得可以去看看,读读源码,提提pr!给简历加1分

说来就来,左手fork 右手git clone...哈哈哈

image.png

备注:

文章所用代码已经上传github

新手小白,难免有跑偏。有不正确的,希望批评指出,感谢你的时间!!

END

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容