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

相关文章

Java内存分配与JVM参数详解(推荐)

《Java内存分配与JVM参数详解(推荐)》本文详解JVM内存结构与参数调整,涵盖堆分代、元空间、GC选择及优化策略,帮助开发者提升性能、避免内存泄漏,本文给大家介绍Java内存分配与JVM参数详解,... 目录引言JVM内存结构JVM参数概述堆内存分配年轻代与老年代调整堆内存大小调整年轻代与老年代比例元空

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四

mysql表操作与查询功能详解

《mysql表操作与查询功能详解》本文系统讲解MySQL表操作与查询,涵盖创建、修改、复制表语法,基本查询结构及WHERE、GROUPBY等子句,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随... 目录01.表的操作1.1表操作概览1.2创建表1.3修改表1.4复制表02.基本查询操作2.1 SE

MySQL中的锁机制详解之全局锁,表级锁,行级锁

《MySQL中的锁机制详解之全局锁,表级锁,行级锁》MySQL锁机制通过全局、表级、行级锁控制并发,保障数据一致性与隔离性,全局锁适用于全库备份,表级锁适合读多写少场景,行级锁(InnoDB)实现高并... 目录一、锁机制基础:从并发问题到锁分类1.1 并发访问的三大问题1.2 锁的核心作用1.3 锁粒度分

MySQL数据库中ENUM的用法是什么详解

《MySQL数据库中ENUM的用法是什么详解》ENUM是一个字符串对象,用于指定一组预定义的值,并可在创建表时使用,下面:本文主要介绍MySQL数据库中ENUM的用法是什么的相关资料,文中通过代码... 目录mysql 中 ENUM 的用法一、ENUM 的定义与语法二、ENUM 的特点三、ENUM 的用法1

MySQL count()聚合函数详解

《MySQLcount()聚合函数详解》MySQL中的COUNT()函数,它是SQL中最常用的聚合函数之一,用于计算表中符合特定条件的行数,本文给大家介绍MySQLcount()聚合函数,感兴趣的朋... 目录核心功能语法形式重要特性与行为如何选择使用哪种形式?总结深入剖析一下 mysql 中的 COUNT

一文详解Git中分支本地和远程删除的方法

《一文详解Git中分支本地和远程删除的方法》在使用Git进行版本控制的过程中,我们会创建多个分支来进行不同功能的开发,这就容易涉及到如何正确地删除本地分支和远程分支,下面我们就来看看相关的实现方法吧... 目录技术背景实现步骤删除本地分支删除远程www.chinasem.cn分支同步删除信息到其他机器示例步骤

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

mysql中的服务器架构详解

《mysql中的服务器架构详解》:本文主要介绍mysql中的服务器架构,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、背景2、mysql服务器架构解释3、总结1、背景简单理解一下mysqphpl的服务器架构。2、mysjsql服务器架构解释mysql的架

ModelMapper基本使用和常见场景示例详解

《ModelMapper基本使用和常见场景示例详解》ModelMapper是Java对象映射库,支持自动映射、自定义规则、集合转换及高级配置(如匹配策略、转换器),可集成SpringBoot,减少样板... 目录1. 添加依赖2. 基本用法示例:简单对象映射3. 自定义映射规则4. 集合映射5. 高级配置匹