VuePress 学习记录

大约 7 分钟使用指南

VuePress 快速入门

Vuepress 非常适配搭建个人知识体系网站, 因此对比市面上的产品, 我选择 vuepress 作为知识体系打造的平台

Vuepress 依赖的基础知识

要学习 VuePress,你需要掌握一些前置知识。以下是一些你需要了解的基础知识:

  1. HTMLopen in new windowCSSopen in new windowJavaScriptopen in new windowVuePressopen in new window 是一个基于 Vue.js 的静态站点生成器,所以你需要掌握 HTML、CSS 和 JavaScript 的基础知识,才能更好地理解 VuePress 的工作原理。
  2. Vue.jsopen in new window:VuePress 是基于 Vue.js 的,所以你需要掌握 Vue.js 的基础知识,包括组件、指令、生命周期、事件等等。
  3. Markdownopen in new window:VuePress 使用 Markdown 语法来编写页面内容,所以你需要掌握 Markdown 的基础语法。
  4. Node.jsopen in new window 和 npm:VuePress 是一个基于 Node.js 的工具,所以你需要了解 Node.js 和 npm 的基础知识,包括如何安装和使用它们。
  5. Gitopen in new window:VuePress 的文档是使用 Git 进行版本控制的,所以你需要掌握 Git 的基础知识,包括如何创建仓库、提交代码、拉取代码等等。
  6. Webpackopen in new window:VuePress 使用 Webpack 进行打包,所以你需要了解 Webpack 的基础知识,包括如何配置、如何打包等等。

以上是一些你需要了解的基础知识,这些知识将有助于你更好地理解 VuePress 的工作原理,从而更加轻松地学习和使用 VuePress。

快速开始一个项目

参考 theme-home 小白教程open in new window ,快速开始一个项目入门,包括以下部分

Vuepress 的配置

配置的介绍

VuePress 主要通过目录下的 .vuepress/ 文件夹存放配置和需要的文件。

在 VuePress 中,有三种配置概念:

  • 站点配置: 这是你在配置文件中直接导出的对象
  • 主题配置: 传递给 hopeTheme 的第一个对象
  • 页面配置: 由在页面顶部基于 YAML 语法的 Frontmatter 提供

主题配置

主题的基本选项

主题功能选项

主题布局选项

主题外观选项

主题多语言选项

主题行为选项

插件配置

可以说插件才是 vuepress-theme-hope的灵魂,没有插件,无法做到丰富多彩

插件说明

博客配置

评论插件配置open in new window

版权信息插件

Feed 插件配置open in new window

PWA插件配置open in new window

vuepress-plugin-pwa2 插件默认禁用,提供渐进式网络应用程序支持。

vuepress-theme-hope 将主题选项中的 plugins.pwa 作为插件选项传递给 vuepress-plugin-pwa2 插件。

MdEnhance 插件(很强大)open in new window

vuepress-plugin-md-enhance 插件默认启用,提供 Markdown 增强功能。

vuepress-theme-hope 将主题选项中的 plugins.mdEnhance 作为插件选项传递给 vuepress-plugin-md-enhance 插件。

Formater 配置open in new window

Formater 主要是针对全局配置或者需要单个页面定制的时候, 用来覆盖页面级别的配置,是几个配置最小细粒度的配置。

信息Formater 配置open in new window

布局Formater 配置(重要)open in new window

插件Formater 配置open in new window

主页Formater 配置(重点)open in new window

  • home
  • title
  • heroTest
  • tagline
  • heroImage
  • heroImageDark
  • heroAlt
  • actions
  • features

博客主页配置open in new window

高级

我现在能够想到的内容就是插件和 markdown 增强部分的内容

常见问题

在开发过程中遇到的哪些问题, 记录下来,避免再次再出现

关于编译和部署

程序启动 pnpm docs:dev

程序打包,目前已经打通了 github 的推送钩子,实现了自动编译。

程序编译打包 pnpm docs:build 会在项目输出 dist 目录, 这个目录就是最终打包出来的项目内容

关于自动部署编译

参考文档 Github Actions自动部署腾讯云open in new window

作者:喂。小欢lv-3

感谢提供!

关于自动化构建,参考文档 通过 GithubAction 部署到华为云服务器open in new window

github actioins ==> 然后推送到目标服务器。

备注:程序打包,目前已经打通了 github 的推送钩子,实现了自动编译。

关于如何增加一个导航栏

由于导航栏是整个知识体系的导航系统,所以我希望它能够根据我的目录自动生产这个导航栏,不需要我再去维护,我只需要新建好目录, 编写文章即可

比如我需要新增一个大类 人工智能, 我只需要新建几个目录即可, 不再去维护那些导航路径了 , 怎么开始呢

参考 导航栏配置open in new window 中的布局, 结论:

  • 导航栏还是需要手动维护 Nav ,具体的目录就是在 src/.vuepress/navbar/zh.ts 文件里面
  • 具体的导航栏路径则通过 文件目录生成,比我有一个 数据库 的导航栏,那么目录对应是 database , 然后有一个达梦的体系,则再建一个 dm 的目录,那么达梦数据库的完整路径就是 /database/dm
  • 同时需要在对应 dm 的目录下面新建一个 README的文件,代表了这个路径

具体的路径 .vuepress ==> navbar ==> zh.ts 修改

关于侧边栏的维护

侧边栏都是自动生成的 只需要增加对应的目录 和 Markdown 文件即可自动生成 对于目录下的跟目录文件生成侧边栏的问题, 可以通过不加入在 formatter 配置不加入导航栏即可。

.vuepress ==> sidebar ==> zh.ts 修改

如何执行知识体系的总结呢

  • 明确知识点 ,

比如 Nginx , 只要以后与 Nginx 相关的知识, 你一看思维导图, 那么你就大概知道是怎么回事了

  • 形成思维导图
  • 查找对应的书籍或者官方文章,明确大纲。
  • 根据大纲细化内容,形成一张思维导图
  • 根据思维导图拆解成不同的文章, 一般按 入门 ,进阶 ,高级划分
  • 根据思维导图拆分不同页面和具体的路径
    • 编辑导航栏 (复用) 大类就是新建一个列(非必需)
    • 编辑侧边栏 (复用) 只需要新增目录或者 README 文件即可

具体举例子:

  • 明确 人工智能主题
  • 查找文章, ‘人工智能领域的系列文章’
  • 规划好文章

达梦数据库的十篇文章

1.《达梦数据库安装和配置指南》:这篇文章介绍了如何安装和配置达梦数据库,包括环境要求、安装步骤、配置文件等。

2.《达梦数据库基础教程》:这篇文章介绍了达梦数据库的基础知识,包括数据库结构、数据类型、SQL语句等。

3.《达梦数据库高级教程》:这篇文章介绍了达梦数据库的高级特性,包括存储过程、触发器、备份和恢复等。

4.《达梦数据库性能优化指南》:这篇文章介绍了如何优化达梦数据库的性能,包括索引、分区、优化SQL语句等。

5.《达梦数据库安全指南》:这篇文章介绍了如何保护达梦数据库的安全,包括用户管理、权限控制、加密等。

6.《达梦数据库运维指南》:这篇文章介绍了如何进行达梦数据库的日常运维工作,包括监控、调优、备份等。

7.《达梦数据库与Java集成指南》:这篇文章介绍了如何使用Java编程语言与达梦数据库进行集成,包括数据库连接、数据操作等。

  • 根据 每篇文章细分对应文章的内容和对应的文章标题