作者:Michael Thiessen 最近有人在问:小智, Vue3 有没有对应制作文档的工具。于是,我去查了一些资料,发现,Vue3和新的Vite构建工具为我们提供了另一种快速开发静态站点的方法,那就是 Vitepress。今天,我们来一起看看,如何使用 Vitepress 快速为Vue应用创建文档。下面是我们最后要完成的内容:在开始之前,我们先来看看 Vitepress 是个啥东西。Vite
随着开源项目knife4j添加的新特性越来越多,搭建一个开源软件的技术博客迫在眉睫,针对非专业前端的开发者来说,能快速搭建一个网站当然是最好的,正好,看到了VuePress这款产品特点简直是和自己完美契合,主要有几点;通过编写Markdown文件就可以轻松完成整个站点的内容输出,不用考虑排版,专注于协作基于Vue、Node等技术的可插拔式的自定义插件开发体系,构建自定义的主题、插件等简单、方便安装
转载
2024-05-07 13:47:01
26阅读
4.1 项目结构首先说明一下官方推荐的目录结构:4.2 创建项目文件夹可以右键手动新建,也可以使用 mkdir 命令新建:mkdir vuepressBlogDemo全局安装 VuePressnpm install -g vuepress进入 vuepressBlogDemo 文件夹,初始化项目 使用 npm init 或 npm init -y(默认yes)npm init -y4.3 创建文件
转载
2024-07-24 17:43:34
100阅读
花了2天多的时间总算搭出一个博客的雏形了。 搭建的博客没有使用官方提供的主题,而是自己创建了一个主题。所以,在样式上,有自己的风格和特点。转入正题。
环境搭建安装VuePressyarn global add vuepress
或者:npm install -g vuepress
也可以直接下载我的代码。然后cnpm i 下载依赖 https://github.com/newway7/blog
转载
2024-02-29 06:50:12
55阅读
在项目扩展到一定程度,我们会对项目中大量的公共业务做封装,当多人开发时就带来一个问题:如何让所有人快速使用封装好的组件,降低学习成本?这里提供一个解决方案,那就是Vuepress框架,最新的 Vuepress2.x 框架已经蓄势待发,支持Vue3.x。一、创建一个基础Vuepress项目1、创建并进入一个新目录创建VuepressDocs目录mkdir VuepressDocs
cd Vuepre
转载
2024-06-27 17:13:24
246阅读
1 什么是VuePress?vuePress是以vue驱动的主题系统的简约静态网站生成工具2 如何搭建?在官方网址上说的其实很清楚的,这边简要的说一下2.1 利用npm 安装 vuepress# 初始化 npm
npm init -y
# 安装
yarn global add vuepress # 或者:npm install -g vuepress
# 新建一个 docs 文件夹
mkdir
转载
2024-02-22 16:43:50
97阅读
前段时间,docsify 的cdn崩了,我翻了一下很久之前的笔记,打开贼慢不说,样式全没了。于是下定决心找个时间看看有什么好的文档工具重新弄一个,虽然都是几年前的笔记文档,但毕竟这些笔记见证了我的成长,不能丢。最终选定了vuePress2,下面将记录使用 vuePress2 的详细过程。vuepress官方文档https://v2.vuepress.vuejs.org/zh/使用 vuepress
说明最近想把常用的一些干货知识点都集中起来,方便发布和查找。相当于创建一个自己的知识库,我就叫它Java技术文档。虽然博客写文档也挺方便,但是在于文档的集中阅读和管理方面还是不够简洁和快速。此处就以Vue官方文档举例,它就是用的自家技术vuepress创建的。关于vuepresshttps://www.vuepress.cn/关于github pagesGithub Pages其实等于jekyll
转载
2024-04-22 11:34:55
88阅读
最终效果使用方式页面效果一、需求vitepress-theme-demoblock插件在编辑md文件时,不支持TSX模式,也无法import其他依赖,并且展开隐藏的vue代码都在md文件中,不够优雅,且每个md文件太长。至此弃用此拆件,改用自己封装demo组件二、plugins配置:在docs/.vitepress下新建config文件夹1、在config文件夹新建global.ts文件,代码如下
转载
2024-04-10 20:37:50
157阅读
前言在上一篇文章 vuepress(一):搭建个人博客插件的使用基础用法module.exports = {
plugins: [ 'vuepress-plugin-xxx', .... ]
}Babel 式module.exports = {
plugins: [
[
'vuepress-plugin-xxx',
{ /* options */ }
转载
2024-05-25 16:41:32
39阅读
Vuepress Vuepress 从名字上看就知道
原创
2022-07-24 00:35:51
313阅读
百家饭团队开发的百家饭OpenAPI平台是用vuepress2.0搭建的,搭建的时候不知道2.0还处在beta状态,所以导致后来踩了一些坑,使用过程中vuepress2.0也从2.0.0-beta.18升到了2.0.0-beta.48,有很多的变化,所以想写一个教程介绍一下vuepress2.0的情况以及使用经验。这里先给搜索进来的同学提个醒:
转载
2024-03-07 07:10:56
39阅读
续?VuePress、VuePress-theme-hope 搭建个人博客 1【快速上手】项目常用命令
vuepress dev [dir] 会启动一个开发服务器,以便让你在本地开发你的 VuePress 站点。
vuepress build [dir] 会将你的 VuePress 站点构建成静态文件,以便你进行后续部署。使用模板如果使用 VuePress Theme Hope
转载
2024-07-31 13:00:50
45阅读
前言从 9 月份开始,vuepress 源码进行了重新设计和拆分。先是开了个 next 分支,后来又合并到 master 分支,为即将发布的 1.x 版本做准备。最主要的变化是:大部分的全局功能都被拆分成了插件的形式,以可插拔的方式来支撑 vuepress 的运作,这一点很像 webpack。具体架构如下: 架构从图中我们可以看出,vuepress 被划分成了两个部分:前端部分和服务端
转载
2024-04-01 13:29:52
218阅读
vuepress 实用插件这些插件都是官方提供的,有些在我们实用默认主题的时候已经安装了,不需要再单独安装,有些插件需要我们单独安装。具体请看下面的介绍默认主题自带的插件@vuepress/plugin-active-header-links@vuepress/plugin-nprogress@vuepress/plugin-searchvuepress-plugin-containervuepr
转载
2024-03-16 10:11:54
277阅读
使用技术VuePress + vuepress-theme-recoVuePress简介VuePress文档地址简洁至上:以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。Vue 驱动:享受 Vue + webpack 的开发体验,可以在 Markdown 中使用 Vue 组件,又可以使用 Vue 来开发自定义主题。高性能:VuePress 会为每个页面预渲染生成静态的 HTM
转载
2023-12-24 08:00:41
56阅读
1)VuePress是什么?先让我们看看 VuePress能干什么?有什么效果?image.png
很像vue官网的文档页面,因为vuePress就是尤大大的一个力作
vuePress官网介绍介绍的很详细,这里只做搭建VuePress项目教程
2)安装
注意 VuePress基于node 8.0+
npm install -g vuepress
创建工作文件夹 study
进入文件夹
快速初始化p
转载
2024-08-30 22:37:25
45阅读
使用vuepress-theme-reco搭建自己的博客vuepress-theme-reco是VuePress的一个主题,大家可以参考VuePress和其他主题,搭建你自己风格的主题,这篇主要讲解vuepress-theme-reco主题的博客。VuePress是静态网页生成器,通过它,可以迅速的将我们的Markdown笔记变成网页,方便我们翻阅,查找。一、初始化项目1、引入vuepress-t
转载
2024-04-03 12:58:17
37阅读
Vuepress 使用 github actins 实现自动部署说明在使用 Vuepress 写完文档后,就是部署了。那么如果每次都手动打包的话,比较麻烦,所以就使用 github 提供的自动部署服务, actions 来实现自动部署。配置首先是在使用 github actions 时,需要配置下 vuepress 项目的配置文件,看你需要部署在xxx.github.io/xxx/ 上,还是 xx
转载
2024-03-19 20:08:48
86阅读
一、Node环境安装1.进入Node官网,下载19.0.0版本,安装到Windows系统。 https://nodejs.org2.安装pnpmnpm install -g pnpm安装以后,可以使用上述命令升级到最新版本。 二、VuePress安装进入vuepress的官网,按照指引安装。 https://v2.vuepress.vuejs.org/1.建立目录mk
转载
2024-04-23 21:21:53
98阅读