秒建炫酷的开源项目文档，这款神器用起来够优雅

来源：file/tupian/20220807/pp学习过我的开源项目mall的朋友应该知道，我有一个使用Docsify 搭建的项目文档网站。使用Docsify搭建文档网站虽然简单，但是缺少分类、标签、SEO这类功能，随着文档越来越多，查找起来有点不方便！今天给大家推荐一个炫酷的文档主题vuepress-theme-hope，用来搭建项目文档网站正合适！

vuepress-theme-hope 简介

vuepress-theme-hope是一个具有强大功能的VuePress主题，为Markdown添加了更多增强语法，可用于搭建项目文档和博客网站。支持分类和标签功能，可以让你的文档更加结构化！内置多种插件，功能强大，值得一试！

演示效果

我们先来看下使用vuepress-theme-hope搭建的网站演示效果，还是挺炫酷的！

安装

使用vuepress-theme-hope搭建文档网站非常简单，基本就是开箱即用，我们先来安装它。

首先在安装目录下创建docs目录，然后使用如下命令初始化项目；

npm init vuepress-theme-hope@next docs

初始化过程中会安装所有依赖，还需要对项目进行一些设置，具体参考下图；

安装完成后可以选择立刻启动，也可以使用如下命令启动；

npm run docs:dev

启动成功后即可访问，下面是我已经配置完成的效果图，访问地址：http://localhost:8080/

我们可以发现该主题不仅支持多种颜色的切换，还支持深色模式和浅色模式，还是挺炫酷的！

使用

接下来介绍下vuepress-theme-hope主题的使用，主要是一些界面组件的使用和自定义配置。

目录结构

首先我们来了解下项目的整体目录结构，这对我们之后使用该主题会有很大的帮助。

这里需要注意的是，如果运行过程中出现错误，可以尝试删除.cache和.temp两个临时文件夹。

导航栏

一般来说我们都有修改顶部导航栏的需求，例如我们想要按照如下样式定制下导航栏；

可以修改navbar.ts文件，修改内容如下，修改后的导航栏可支持子级目录，既可以导航到本站，也可以导航到外部链接。

export default defineNavbarConfig;

侧边栏

修改侧边栏也是个常见需求，例如给项目文档配置下目录，方便查看，比如我的mall学习教程的侧边栏；

实现上面的效果需要修改sidebar.ts文件，值得一提的是vuepress-theme-hope支持针对不同路径实现不同的侧边栏，这样就不用把所有文档侧边栏糅合在一起了；

export default defineSidebarConfig;

看下配置好的SpringCloud学习教程的侧边栏，和mall学习教程的是分开的，结构更加清晰的了，这是使用Docsify无法做到的。

图标

vuepress-theme-hope主题默认支持使用iconfont上的图标，我们可以在项目文档中直接使用，以下是一些精选图标；

由于在themeConfig.ts中配置了图标前缀，在使用时需要去除icon-前缀。

export default defineThemeConfig

信息定制

在使用vuepress-theme-hope搭建自己的项目文档网站时，需要定制一些自己的信息，比如作者名称、文档链接、logo等信息，可以在themeConfig.ts中修改。

export default defineThemeConfig;

文档首页

首页信息可以在home.md中进行修改，比如下面样式的项目文档首页：

修改内容如下，支持在首页上添加多个自定义模块。

---home: trueicon: hometitle: mall学习教程heroImage: /logo.pngheroText: mall学习教程tagline: mall学习教程，架构、业务、技术要点全方位解析。mall项目是一套电商系统，使用现阶段主流技术实现。actions:  - text: 使用指南     link: /mall/foreword/mall_foreword_01  - text: SpringCloud系列     link: /springcloud/springcloud    type: secondaryfeatures:  - title: mall学习教程    icon: markdown    details: mall学习教程，架构、业务、技术要点全方位解析。mall项目是一套电商系统，使用现阶段主流技术实现。    link: /mall/foreword/mall_foreword_01  - title: SpringCloud学习教程    icon: slides    details: 一套涵盖大部分核心组件使用的Spring Cloud教程，包括Spring Cloud Alibaba及分布式事务Seata，基于Spring Cloud Greenwich及SpringBoot 2.1.7。    link: /springcloud/springcloud  - title: K8S系列教程    icon: layout    details: 实实在在的K8S实战教程，专为Java方向人群打造！只讲实用的，抛弃那些用不到又难懂的玩意！同时还有配套的微服务实战项目mall-swarm，很好很强大！    link: file/tupian/20220807/6962026171823292452      - title: mall    icon: markdown    details: mall项目是一套电商系统，包括前台商城系统及后台管理系统，基于SpringBoot+MyBatis实现，采用Docker容器化部署。    link: file/tupian/20220807/mall      - title: mall-admin-web    icon: comment    details: mall-admin-web是一个电商后台管理系统的前端项目，基于Vue+Element实现。    link: file/tupian/20220807/mall-admin-web  - title: mall-swarm    icon: info    details: mall-swarm是一套微服务商城系统，采用了 Spring Cloud Hoxton & Alibaba、Spring Boot 2.3、Docker、Kubernetes等核心技术。    link: file/tupian/20220807/mall-swarm      - title: mall-tiny    icon: blog    details: mall-tiny是一款基于SpringBoot+MyBatis-Plus的快速开发脚手架，拥有完整的权限管理功能，可对接Vue前端，开箱即用。    link: file/tupian/20220807/mall-tiny    copyright: falsefooter: MIT Licensed | Copyright  2019-present macrozheng---

博客首页

vuepress-theme-hope主题不仅可以做项目文档网站，也可以做博客网站，我们先来看下它生成的博客首页样式；

分类及标签

---home: truelayout: Blogicon: hometitle: 主页heroImage: /logo.pngheroText: macrozheng的个人博客heroFullScreen: truetagline: 这家伙很懒，什么都没写...projects:  - icon: project    name: mall    desc: mall项目是一套电商系统，包括前台商城系统及后台管理系统，基于SpringBoot+MyBatis实现，采用Docker容器化部署。    link: file/tupian/20220807/mall  - icon: link    name: mall-admin-web    desc: mall-admin-web是一个电商后台管理系统的前端项目，基于Vue+Element实现。    link: file/tupian/20220807/mall-admin-web  - icon: book    name: mall-swarm    desc: mall-swarm是一套微服务商城系统，采用了 Spring Cloud Hoxton & Alibaba、Spring Boot 2.3、Docker、Kubernetes等核心技术。    link: file/tupian/20220807/mall-swarm  - icon: article    name: mall-tiny    desc: mall-tiny是一款基于SpringBoot+MyBatis-Plus的快速开发脚手架，拥有完整的权限管理功能，可对接Vue前端，开箱即用。    link: file/tupian/20220807/mall-tinyfooter: 自定义你的页脚文字---

代码样式

当然如果你觉得vuepress-theme-hope默认的代码主题不够炫酷，也可以自定义一下，默认是one-light和one-dark主题，还有多达十几种深浅色主题可供选择；

需要修改下config.scss文件，这里改为了material系列的主题；

$codeLightTheme: material-light;$codeDarkTheme: material-dark;

浅色模式下代码样式如下；

深色模式下代码样式如下，还是挺炫酷的！

分类及标签

vuepress-theme-hope内置了分类和标签功能，可以让我们的项目文档更加结构化，查看内容也更方便，直接在文章顶部添加category和tag即可实现；

---title: mall整合SpringBoot+MyBatis搭建基本骨架date: 2021-08-19 16:30:11category:  - mall学习教程  - 架构篇tag:  - SpringBoot  - MyBatis---

添加成功后我们的文章标题下方会出现分类和标签；

点击分类可以查看该分类下所有文章；

点击标签可以查看所有