Vue进阶(九十六):VuePress 详解

2024-02-16 19:18

本文主要是介绍Vue进阶(九十六):VuePress 详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

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

文章目录

      •      佛语:“赠人玫瑰,手留余香。” 若您感觉博文内容与您有益,请点赞并收藏!
      •      敬请关注作者,海量博文持续更新中。望与各位码友同学习,共进步!
    • 一、介绍
    • 二、VuePress 优点
    • 三、运行原理
    • 四、项目搭建
      • 4.1 项目结构
      • 4.2 创建项目文件夹
      • 4.3 创建文件夹和文件
      • 4.4国际化
      • 4.5 项目启动
    • 五、部署上线
    • 六、示例演示
    • 七、一些小亮点
    • 八、拓展阅读


一、介绍

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

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

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

二、VuePress 优点

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

三、运行原理

VuePress 搭建的静态网站实际上是由 Vue, Vue Routerwebpack 驱动的单页面应用程序。如果你以前使用过 Vue,那么在编写或开发自定义主题时(甚至可以使用 Vue DevTools 来调试你的自定义主题!),你会融入到熟悉的开发体验中!

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

四、项目搭建

4.1 项目结构

首先说明一下官方推荐的目录结构:
在这里插入图片描述

4.2 创建项目文件夹

可以右键手动新建,也可以使用 mkdir 命令新建:

mkdir vuepressBlogDemo

全局安装 VuePress

npm install -g vuepress

进入 vuepressBlogDemo 文件夹,初始化项目
使用 npm initnpm 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: {// ...}}}
}

navsidebar和前文字段含义相同。

相应的也要增加国际化相应的文件夹及文件,整体结构跟原结构一致,如图:
在这里插入图片描述

4.5 项目启动

一切就绪,启动项目

npm run dev

五、部署上线

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

六、示例演示

部署在本地的项目演示效果如下:
在这里插入图片描述
在这里插入图片描述

国际化部分,还需要再做研究设计。

七、一些小亮点

完成了基础搭建后,就可以在docs目录下新建 .md 文件写文章了(.mdMarkdown 语法文件,你需要掌握 Markdown 的一些基本写法)

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

八、拓展阅读

  • 《Vue进阶(幺零三):Markdown基本语法》

这篇关于Vue进阶(九十六):VuePress 详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/715452

相关文章

MySQL数据库双机热备的配置方法详解

《MySQL数据库双机热备的配置方法详解》在企业级应用中,数据库的高可用性和数据的安全性是至关重要的,MySQL作为最流行的开源关系型数据库管理系统之一,提供了多种方式来实现高可用性,其中双机热备(M... 目录1. 环境准备1.1 安装mysql1.2 配置MySQL1.2.1 主服务器配置1.2.2 从

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本,并kill2.1 进程查看2.2 遇到的

MyBatis常用XML语法详解

《MyBatis常用XML语法详解》文章介绍了MyBatis常用XML语法,包括结果映射、查询语句、插入语句、更新语句、删除语句、动态SQL标签以及ehcache.xml文件的使用,感兴趣的朋友跟随小... 目录1、定义结果映射2、查询语句3、插入语句4、更新语句5、删除语句6、动态 SQL 标签7、ehc

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置

从基础到高级详解Go语言中错误处理的实践指南

《从基础到高级详解Go语言中错误处理的实践指南》Go语言采用了一种独特而明确的错误处理哲学,与其他主流编程语言形成鲜明对比,本文将为大家详细介绍Go语言中错误处理详细方法,希望对大家有所帮助... 目录1 Go 错误处理哲学与核心机制1.1 错误接口设计1.2 错误与异常的区别2 错误创建与检查2.1 基础

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV(使用 StorageClass)创建 StorageClass2.创建 PV

vite搭建vue3项目的搭建步骤

《vite搭建vue3项目的搭建步骤》本文主要介绍了vite搭建vue3项目的搭建步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1.确保Nodejs环境2.使用vite-cli工具3.进入项目安装依赖1.确保Nodejs环境

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

Nginx搭建前端本地预览环境的完整步骤教学

《Nginx搭建前端本地预览环境的完整步骤教学》这篇文章主要为大家详细介绍了Nginx搭建前端本地预览环境的完整步骤教学,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录项目目录结构核心配置文件:nginx.conf脚本化操作:nginx.shnpm 脚本集成总结:对前端的意义很多

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D