一个好用的文档部署工具-VitePress

简介

尤大大又出手了,这次他带来了VitePress1.0,一个基于Vite和Vue前端框架构建的静态站点生成器(SSG)。它主要用于快速搭建静态网页项目,尤其适合开发文档较多的场景,同时也支持自定义主题开发官网、博客等项目。

性能

VitePress 构建时,会为站点创建一个 SSR(服务端渲染)的版本,然后通过虚拟访问每一条路径来渲染对应的 HTML。这种方案的灵感来源于 Nuxt 和 Gatsby 等项目。传统的 SSG 每次导航都会导致页面完全重载,VitePress 的 SSG 会在首次访问时提供静态 HTML,再变成了 SPA(单页应用程序)进行站内的后续导航,包括但不限于:

  • 初始加载很快

  • 加载完毕后快速切换

  • 高效的交互

特性

  • Markdown支持:VitePress支持获取用Markdown编写的内容,并对其进行主题应用,最终生成可以轻松部署的静态HTML页面。

  • Vue组件使用:VitePress支持使用Vue组件进行开发,享受Vite的热更新功能。

  • 自定义主题:VitePress支持自定义主题,具有标准Vite+Vue应用程序的开发体验。

  • 单页应用程序:与许多传统的静态站点生成器不同,VitePress生成的站点实际上是一个单页应用程序(SPA)。对任何页面的初次访问都将是静态HTML,后续页面加载JavaScript,变成Vue SPA单页应用程序。用户在站点内浏览时,不会再次触发整个页面的刷新。

使用步骤

  • 安装VitePress:

yarn add --dev vitepress

npm i vitepress --save

  • 创建项目文件夹:

在你的项目根目录下创建一个放置页面的文件夹,例如,如果你要创建的是文档,那么可以创建一个名为 docs 的文件夹。

  • 创建索引文件:

在项目最外层创建一个 index.md 文件。

  • 添加脚本命令:

在你的项目根目录下的 package.json 文件中添加如下指令,如

"docs:dev": "vitepress dev docs", "docs:build": "vitepress build docs", "docs:serve": "vitepress serve docs"

  • 启动项目:

yarn docs:dev

npm run docs:dev

预览地址 http://localhost:3000/

相关推荐
胡萝卜术37 分钟前
从API调用到手写LRU:力扣146「LRU缓存」的哈希表+双向链表终极进化之路
前端·javascript·面试
科技道人40 分钟前
记录 默认置灰/禁用 app ‘Search Engine Selector‘ 的disable按钮
开发语言·前端·javascript
天疆说1 小时前
Zotero Connector 在 Edge 里找不到桌面 Zotero(Linux / Zotero 9.0.6 / Edge 150)
linux·前端·edge
李伟_Li慢慢2 小时前
02-从硬件说起WebGL
前端·three.js
kyriewen3 小时前
看了微软几万人用AI编程的数据——效率涨24%的代价没人提
前端·ai编程·claude
2601_963771373 小时前
How to Scale Your WordPress Store Traffic in 2026
前端·php·plugin
亿元程序员3 小时前
老板说我的3D箭头游戏用来做试玩太普通了,没人想玩,让我变点花样...
前端
李伟_Li慢慢4 小时前
01-threejs架构原理-课程简介
前端·three.js
_瑞5 小时前
深入理解 iOS 渲染原理
前端·ios
IT_陈寒5 小时前
SpringBoot自动配置失灵?你可能忘了这个关键注解
前端·人工智能·后端