百度360必应搜狗淘宝本站头条
vue dispatchspring gatewayorder by ascidea eval resetupdate canceled
当前位置：网站首页 > 技术分类 > 正文

Vue进阶(九十六):VuePress（vue @keypress）

ztj100 2024-10-27 18:36 20 浏览 0 评论

佛语：“赠人玫瑰，手留余香。” 若您感觉博文内容与您有益，请点赞并收藏！

敬请关注作者，海量博文持续更新中。望与各位码友同学习，共进步！

1.介绍

VuePress ,一个全新的基于 vue 的静态网站生成器，实际上就是一个 vue 的 spa 应用，内置 webpack，可以用来写文档。

VuePress 由两部分组成：一个以 Vue 驱动的主题系统简约静态网站生成工具，和一个为编写技术文档而优化的默认主题。它是为了支持 Vue 子项目的文档需求而创建的。

由 VuePress 生成的每个页面，都具有相应的预渲染静态 HTML，它能提供出色的加载性能，并且对 SEO 友好。页面加载之后，Vue 就会将这些静态内容接管为完整的单页面应用程序(SPA)。当用户在浏览站点时，可以按需加载其他页面。

2.VuePress 优点

  • 界面简洁优雅；
  • 容易上手；
  • 更好的兼容、扩展 Markdown 语法；
  • 响应式布局，PC端、手机端；
  • Google Analytics 集成；
  • 支持 PWA

3.运行原理

VuePress 网站实际上是由 Vue, Vue Router 和 webpack 驱动的单页面应用程序。如果你以前使用过 Vue，那么在编写或开发自定义主题时（甚至可以使用 Vue DevTools 来调试你的自定义主题！），你会快速融入到熟悉的开发体验中！

在构建过程中，我们会创建应用程序的服务器渲染版本，并且实际上是通过访问每个路由，来渲染相应的 HTML。这种方式受到 Nuxt 的 nuxt generate 命令以及 Gatsby 等其他项目的启发。

4.项目搭建

4.1 项目结构

首先说明一下官方推荐的目录结构：

4.2 创建项目文件夹

可以右键手动新建，也可以使用 mkdir 命令新建：

mkdir vuepressBlogDemo

全局安装 VuePress

npm install -g vuepress

进入 vuepressBlogDemo 文件夹，初始化项目

使用 npm init 或 npm init -y（默认yes）

npm init -y

4.3 创建文件夹和文件

在 vuepressBlogDemo 文件夹中创建 docs 文件夹，在 docs 中创建 .vuepress 文件夹，在.vuepress中创建 public 文件夹和 config.js 文件，最终项目结构如下所示：

vuepressBlogDemo

├─── docs

│ ├── README.md

│ └── .vuepress

│ ├── public

│ └── config.js

└── package.json

在 config.js 文件中配置网站标题、描述、主题等信息

module.exports = {
    themeConfig: {
        nav: [{
            text: '唐',
            link: '/tang/'
        }, {
            text: '宋',
            link: '/song/'
        }, {
            text: '更多',
            link: '/more/'
        }],
        sidebar: {
           '/tang/': [
               ['', '简介'], {
                   title: '代表人物',
                   collapsable: false,
                   children: [
                       'libai/'
                   ]
               }
           ],
           '/song/': [
               ['', '简介'], {
                   title: '代表人物',
                   collapsable: false,
                   children: [
                       'liqingzhao/'
                   ]
               }
           ]
       }
    }
}

其中，/tang/、/song/、’'和libai/等表示当前导航栏或侧边栏点击所跳转的路由地址（即相应的.md文件），按照路由创建对应的文件。

''会显示为当前目录下的README.md文件。

[’’, ‘简介’]当前侧边栏的title为简介。

/tang/表示为tang文件夹下的README.md，/tang表示为tang.md文件。

可以使用sidebar: auto自动生成侧边栏，采用自定义侧边栏。

在 package.json 文件里添加两个启动命令

"scripts": {
  "dev": "vuepress dev docs",
  "build": "vuepress build docs"
}

4.4国际化

在config.js中添加locales字段，配置国际化。

locales: {
    '/': { // 中文
        lang: 'zh-CN',
        title: '诗词鉴赏',
        description: '静态站点 诗词鉴赏'
    },
    '/en/': { // 英文
        lang: 'en-US', // 将会被设置为 <html> 的 lang 属性
        title: 'Appreciation of poetry',
        description: 'Static Site Appreciation of poetry'
    }
}

配置默认主题的导航栏和侧边栏支持国际化，在上述themeConfig中增加locales字段：

themeConfig: {
	locales: {
		'/': { // 默认语言，这里为中文
			nav: [{
                text: '唐',
                link: '/tang/'
            }],
			sidebar: {
				// ...
			}
		},
		'/en/': { // 英文
			nav: [{
                text: 'Tang',
                link: '/en/tang/'
            }],
			sidebar: {
				// ...
			}
		}
	}
}

nav和sidebar和前文字段含义相同。

相应的也要增加国际化相应的文件夹及文件，整体结构跟原结构一致，如图：

4.5 项目启动

一切就绪，启动项目

npm run dev

5.部署上线

项目开发完毕后，便可像部署其他前端Vue项目一样进行项目部署上线，依赖系统只需要通过链接形式，访问该系统上的相关支持文档。从而实现小助手功能。

6.一些小亮点

完成了基础搭建后，就可以在docs目录下新建 .md 文件写文章了（.md 是 Markdown 语法文件，需要掌握Markdown 的一些基本写法。）

而且，vuepress支持自定义布局以及自定义主题，并且可以使用很多插件以及自定义插件。

相关推荐

再说圆的面积-蒙特卡洛（蒙特卡洛方法求圆周率的matlab程序）

在微积分-圆的面积和周长(1)介绍微积分方法求解圆的面积，本文使用蒙特卡洛方法求解圆面积。...

python编程:如何使用python代码绘制出哪些常见的机器学习图像?

专栏推荐...

python创建分类器小结（pytorch分类数据集创建）

简介：分类是指利用数据的特性将其分成若干类型的过程。监督学习分类器就是用带标记的训练数据建立一个模型，然后对未知数据进行分类。...

matplotlib——绘制散点图（matplotlib散点图颜色和图例）

绘制散点图不同条件（维度）之间的内在关联关系观察数据的离散聚合程度...

python实现实时绘制数据（python如何绘制）

方法一importmatplotlib.pyplotaspltimportnumpyasnpimporttimefrommathimport*plt.ion()#...

简单学Python——matplotlib库3——绘制散点图

前面我们学习了用matplotlib绘制折线图，今天我们学习绘制散点图。其实简单的散点图与折线图的语法基本相同，只是作图函数由plot()变成了scatter()。下面就绘制一个散点图：import...

数据分析-相关性分析可视化（相关性分析数据处理）

前面介绍了相关性分析的原理、流程和常用的皮尔逊相关系数和斯皮尔曼相关系数，具体可以参考...

免费Python机器学习课程一:线性回归算法

学习线性回归的概念并从头开始在python中开发完整的线性回归算法最基本的机器学习算法必须是具有单个变量的线性回归算法。如今，可用的高级机器学习算法，库和技术如此之多，以至于线性回归似乎并不重要。但是...

用Python进行机器学习(2)之逻辑回归

前面介绍了线性回归，本次介绍的是逻辑回归。逻辑回归虽然名字里面带有“回归”两个字，但是它是一种分类算法，通常用于解决二分类问题，比如某个邮件是否是广告邮件，比如某个评价是否为正向的评价。逻辑回归也可以...

【Python机器学习系列】拟合和回归傻傻分不清?一文带你彻底搞懂

一、拟合和回归的区别拟合...

推荐2个十分好用的pandas数据探索分析神器

作者：俊欣来源：关于数据分析与可视化...

向量数据库:解锁大模型记忆的关键!选型指南+实战案例全解析

本文较长，建议点赞收藏，以免遗失。更多AI大模型应用开发学习视频及资料，尽在...

用Python进行机器学习(11)-主成分分析PCA

我们在机器学习中有时候需要处理很多个参数，但是这些参数有时候彼此之间是有着各种关系的，这个时候我们就会想：是否可以找到一种方式来降低参数的个数呢？这就是今天我们要介绍的主成分分析，英文是Princip...

神经网络基础深度解析:从感知机到反向传播

本文较长，建议点赞收藏，以免遗失。更多AI大模型应用开发学习视频及资料，尽在...

Python实现基于机器学习的RFM模型

CDA数据分析师出品作者：CDALevelⅠ持证人岗位：数据分析师行业：大数据...

取消回复欢迎 你 发表评论:

一周热门
最近发表
标签列表
Copyright Your WebSite.Some Rights Reserved.