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

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

SpringBo架构师证书ot实战电商项目mall(50k+star)地址httpwatch:github.com/macrozheng架构/…

vuepHTTPress-th架构师证书eme-hope 简介

vuepress-theme-hohttps域名pe是一个具有强大功工商银行能的VuePress主题,为Markdow架构师和程序员的区别n添加了更多增强语法,可用于搭建项目文档和工商银行博客网站。支持分类和标签功能,可以让你的架构图模板文档更加结构化!内置多种插件,功能强大,值得一试!

演示https和http的区别效果

我们先来看下使用vuepress-架构图theme-hope搭建的网站演示效果,还是挺炫酷的!

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

安装

使用vuepreshttps域名s-th效率eme-hope搭建文档网站非常简单,基本就是开箱即用,我们先来安装HTTPS它。

  • 首先在安公职人员拍视频炫耀防疫通行证装目录下创建https认证docs目录,然后使用如下命令初始化项目;
npm init vuepress-theme-hope@next docs
  • 初始化过程中会安装所有依赖,还需要对项目进行一些设置,具体参考下图;

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

  • http://www.baidu.com装完成后可以http 404选择立刻启动,也龚俊可以使用如下命令https协议启动;
npm run docs:dev
  • 启动成功后即可HTTP访问,架构工程师http://192.168.1.1登录下面是我已经配置完成的效果图,访问地址:htt宫颈癌疫苗p://localhost:8080/

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

  • 我们可以发现该主题不仅支持多种主题色的http://192.168.1.1登录切换,还支持深色模式和浅色模效率高发票查验式,还是挺炫酷的!

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

使用

接下来介绍下vuepress-theme-hohttpclientp龚俊e主题的使用,主http://192.168.1.1登录要是一些界面架构师证书组件的使用和自定义配置架构图怎么制作

目录结构

首先我们来了解架构图下项公职人员拍视频炫耀防疫通行证目的整体目录结构,这对宫颈癌我们之后使用该架构师工资主题会有很大帮助。

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

这里需要效率计算公式注意的是,如果架构图运行过程中出https域名现错http协议误,可以尝试删除.cachttps和http的区别he.temp两个临时文件夹。

导航栏

  • 一般https和http的区别来说我们都有修改顶部导航栏的需求,例如我们想要按如下样式定制下导航栏;

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

  • 可以修改nahttps协议vbar.ts文件,修改内容如下,修改后的导航栏可支持子级目录,既可以导航到本站,也可以导航到外部链接。
export default defineNavbarConfig([
    "/",
    "/home",
    {
        text: "mall学习教程",
        icon: "launch",
        prefix: "/mall/",
        children: [
            {
                text: "序章",
                icon: "note",
                link: "foreword/mall_foreword_01",
            },
            {
                text: "架构篇",
                icon: "note",
                link: "architect/mall_arch_01",
            },
            {
                text: "业务篇",
                icon: "note",
                link: "database/mall_database_overview",
            },
            {
                text: "技术要点篇",
                icon: "note",
                link: "technology/mybatis_mapper",
            },
            {
                text: "部署篇",
                icon: "note",
                link: "deploy/mall_deploy_windows",
            }
        ],
    },
    {
        text: "SpringCloud学习教程",
        icon: "hot",
        link: "/springcloud/springcloud",
    },
    {
        text: "项目地址",
        icon: "stack",
        children: [
            {
                text: "后台项目",
                link: "https://github.com/macrozheng/mall",
            },
            {
                text: "前端项目",
                link: "https://github.com/macrozheng/mall-admin-web",
            },
            {
                text: "学习教程",
                link: "https://github.com/macrozheng/mall-learning",
            },
            {
                text: "项目骨架",
                link: "https://github.com/macrozheng/mall-tiny",
            }
        ],
    },
]);

侧边栏

  • 修改侧边栏也是个常见需求,例如给项目文档配置下目录,方便查看,比如我的m效率公式all学习教程工龄差一年工资差多少的侧边栏;

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

  • 实现上面的效果需要修改sidebar.ts文件,值得一提的是vuepress-theme-hope支持针对不同路架构师工资径实现不同的侧边栏,这样就不用把所有龚俊文档侧边栏糅合在一起了;
export default defineSidebarConfig({
  "/mall/":[
    {
      text: "序章",
      icon: "note",
      collapsable: true,
      prefix: "foreword/",
      children: ["mall_foreword_01", "mall_foreword_02"],
    },
    {
      text: "架构篇",
      icon: "note",
      collapsable: true,
      prefix: "architect/",
      children: ["mall_arch_01", "mall_arch_02","mall_arch_03"],
    },
    {
      text: "业务篇",
      icon: "note",
      collapsable: true,
      prefix: "database/",
      children: ["mall_database_overview", "mall_pms_01","mall_pms_02"],
    },
    {
      text: "技术要点篇",
      icon: "note",
      collapsable: true,
      prefix: "technology/",
      children: ["mybatis_mapper", "aop_log"],
    },
    {
      text: "部署篇",
      icon: "note",
      collapsable: true,
      prefix: "deploy/",
      children: ["mall_deploy_windows", "mall_deploy_docker"],
    }
  ],
  "/springcloud":["springcloud", "eureka", "ribbon"]
});
  • 看下配置好的Sprinhttps域名gCloud学习教苟在神诡世界程的侧边Go栏,和mall学习教程的是架构师分开效率计算公式的,结构更加清晰的了,这是使用Docsify无法做到的。

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

图标

  • vuepress-them工商银行e-https和http工商银行的区别hope主题默认支持使用iconfHTTPont上的图标,架构设计我们可以在项目文档中直接使用,以下是一https和http的区别龚俊些精选图标;

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

  • 由于在themeConfig.ts中配置了图标前缀,在使用google时需要去除icon-前缀。
export default defineThemeConfig({
  iconPrefix: "iconfont icon-",
})

信息定制

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

export default defineThemeConfig({
  hostname: "http://www.macrozheng.com",
  author: {
    name: "macrozheng",
    url: "http://www.macrozheng.com",
  },
  iconPrefix: "iconfont icon-",
  logo: "/logo.png",
  repo: "https://github.com/macrozheng",
  docsDir: "demo/src",
  // navbar
  navbar: navbar,
  // sidebar
  sidebar: sidebar,
  footer: "默认页脚",
  displayFooter: true,
  blog: {
    description: "SpringBoot实战电商项目mall(50K+Star)的作者",
    intro: "https://github.com/macrozheng",
    medias: {
      Gitee: "https://gitee.com/macrozheng",
      GitHub: "https://github.com/macrozheng",
      Wechat: "https://example.com",
      Juejin: "https://juejin.cn/user/958429871749192",
      Zhihu: "https://www.zhihu.com/people/macrozheng",
    },
  },
});

文档首页

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

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

  • 修改内公积金容如下,支持在首页上添加多个自定义模块。
---
home: true
icon: home
title: mall学习教程
heroImage: /logo.png
heroText: mall学习教程
tagline: mall学习教程,架构、业务、技术要点全方位解析。mall项目(50k+star)是一套电商系统,使用现阶段主流技术实现。
actions:
  - text: 使用指南 
    link: /mall/foreword/mall_foreword_01

  - text: SpringCloud系列 
    link: /springcloud/springcloud
    type: secondary

features:
  - title: mall学习教程
    icon: markdown
    details: mall学习教程,架构、业务、技术要点全方位解析。mall项目(50k+star)是一套电商系统,使用现阶段主流技术实现。
    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: https://juejin.cn/column/6962026171823292452
  - title: mall
    icon: markdown
    details: mall项目是一套电商系统,包括前台商城系统及后台管理系统,基于SpringBoot+MyBatis实现,采用Docker容器化部署。
    link: https://github.com/macrozheng/mall
  - title: mall-admin-web
    icon: comment
    details: mall-admin-web是一个电商后台管理系统的前端项目,基于Vue+Element实现。
    link: https://github.com/macrozheng/mall-admin-web

  - title: mall-swarm
    icon: info
    details: mall-swarm是一套微服务商城系统,采用了 Spring Cloud Hoxton & Alibaba、Spring Boot 2.3、Docker、Kubernetes等核心技术。
    link: https://github.com/macrozheng/mall-swarm
  - title: mall-tiny
    icon: blog
    details: mall-tiny是一款基于SpringBoot+MyBatis-Plus的快速开发脚手架,拥有完整的权限管理功能,可对接Vue前端,开箱即用。
    link: https://github.com/macrozheng/mall-tiny

    
copyright: false
footer: MIT Licensed | Copyright  2019-present macrozheng
---

博客首页

  • vuepress架构图-thehttp 302me-hope主题不仅可以做项目文档网站效率是什么意Go,也可以做博客网站,我们先来看下它生成的博客首页样式;

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

  • 要实现上面的样式,修改README.md文件即可,修改内容如下。
---
home: true
layout: Blog
icon: home
title: 主页
heroImage: /logo.png
heroText: macrozheng的个人博客
heroFullScreen: true
tagline: 这家伙很懒,什么都没写...
projects:
  - icon: project
    name: mall
    desc: mall项目是一套电商系统,包括前台商城系统及后台管理系统,基于SpringBoot+MyBatis实现,采用Docker容器化部署。
    link: https://github.com/macrozheng/mall

  - icon: link
    name: mall-admin-web
    desc: mall-admin-web是一个电商后台管理系统的前端项目,基于Vue+Element实现。
    link: https://github.com/macrozheng/mall-admin-web

  - icon: book
    name: mall-swarm
    desc: mall-swarm是一套微服务商城系统,采用了 Spring Cloud Hoxton & Alibaba、Spring Boot 2.3、Docker、Kubernetes等核心技术。
    link: https://github.com/macrozheng/mall-swarm

  - icon: article
    name: mall-tiny
    desc: mall-tiny是一款基于SpringBoot+MyBatis-Plus的快速开发脚手架,拥有完整的权限管理功能,可对接Vue前端,开箱即用。
    link: https://github.com/macrozheng/mall-tiny

footer: 自定义你的页脚文字
---

代码样式

  • 当然如果你觉得vu工龄差一年工资差多少epress-theme-hope默认的代码主题不够炫酷,也可以自定义一下,默认是one-lightone-dark主题https域名,还有多达十几种深浅色主题可供选择;

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

  • 需要修改下架构师证书config.scss文件,这里改为了mathttps和http的区别erial系列的主题;
$codeLightTheme: material-light;
$codeDarkTheme: material-dark;
  • 浅色模式下代码样式如下;

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

  • 深色模式下代码样式如下,httpclient还是挺炫酷的!

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

分类及标签

  • vHTTPSuepress-t架构师证书hem效率意识方面存在的问题e-hope内置了分架构图模板类和标签功能,可以让我们的项目文档更加结构化,查看内容也更方便,直接在文章顶部添加ca效率高发票查验tegorytag即可实现;
---
title: mall整合SpringBoot+MyBatis搭建基本骨架
date: 2021-08-19 16:30:11
category:
  - mall学习教程
  - 架构篇
tag:
  - SpringBoot
  - MyBatis
---
  • 添加成功后我们的文章标题下方会出现分类和标签;

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

  • 点击http 404分类可以查看该分类下所有文章;

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

  • 点击标签可以查看所有相关文章,比起Do架构csify查找文章效率大大提高了!

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

总结

vuepress-theme-hope确实是一款好用的工具,用来搭建项目文档网站和博客网站正合适!尤其是它的分类、标签功能,让我们的文档能够更加结构化,查找也更加方便!

如果你想了解更多SpringBo效率英文翻译ot实战技巧的话,可以试试这个带全套教程枸杞的实战项目(http://192.168.1.1登录50K+Star):github.效率计算公式com/httpwatchma架构师chttp 302rozheng/…

效率目地效率的英文

github.com/vuepress-th…

发表评论

提供最优质的资源集合

立即查看 了解详情