yidocs-auto,vitepress 文档侧边栏和导航栏自动生成工具
yidocs-auto
作用
vitepress 导航栏和侧边栏自动生成工具
无需手写侧边栏和顶部导航栏配置!!!
谁开发的
yicode(易编程)系列软件开发生态,全部由陈随易自 2019 年维护至今。
致力于为中小企业、外包公司、软件工作室和个人开发者,提供技术规范、项目模板、效率工具等。
效果
实际效果,请浏览 易文档 https://doc.yicode.tech 查看。
本文档的 顶部导航
和 左侧目录
,均为自动生成。
截图
安装
以下方式,根据自己的情况,任选一种
npm install @yicode/yidocs-auto -D pnpm add @yicode/yidocs-auto -D yarn add @yicode/yidocs-auto -D
使用
参考如下案例即可
import { defineConfig } from 'vitepress'; import { docsAuto } from '@yicode/yidocs-auto'; let { sideBar, navBar } = docsAuto(); export default defineConfig({ base: '/', title: '易文档 - 随易科技', description: '何以解忧,唯有代码。', lastUpdated: true, markdown: { theme: 'material-theme-palenight', lineNumbers: true }, outDir: './dist', srcDir: './markdown', titleTemplate: false, head: [ // [ // 'link', { rel: 'stylesheet', href: 'https://static.yicode.tech/vitepress/vitepress.css' } ], [ 'link', { rel: 'shortcut icon', href: '/favicon.ico' } ] ], themeConfig: { logo: '/logo.png', lastUpdatedText: '更新时间', siteTitle: '易文档', outline: 'deep', outlineTitle: '大纲', socialLinks: [ // { icon: 'github', link: 'https://github.com/chenbimo' } ], footer: { message: '随易科技 - 用心做软件', copyright: 'Copyright © 2019-present 随易科技' }, docFooter: { prev: '上一页', next: '下一页' }, nav: navBar, // 注意:这里不需要手动配置了 sidebar: sideBar // 注意:这里不需要手动配置了 } });
结构
. ├── markdown │ ├── 1-开源 │ │ ├── 1-yite-cli │ │ │ ├── 1-基本简介 │ │ │ │ ├── 1-基本介绍.md │ │ │ │ └── 2-快速体验.md │ │ │ └── 2-项目架构 │ │ │ └── 1-目录含义.md │ │ ├── 2-yibase-vue3 │ │ │ └── 1-基本介绍 │ │ │ └── 1-基本介绍.md │ │ └── 3-yiapi │ │ ├── 1-基本简介 │ │ │ ├── 1-基本介绍.md │ │ │ └── 2-快速体验.md │ │ └── 2-项目架构 │ │ └── 1-目录含义.md │ ├── 2-关于 │ │ └── 1-站长信息 │ │ ├── 1-关于站长.md │ │ └── 2-程序人生.md │ ├── public │ │ ├── favicon.ico │ │ └── logo.png │ └── index.md └── package.json
要求
- 必需按照按照如上文件结构组织文档才可自动生成
- 文件必须放到
markdown
目录中 - 所有文档和目录,都要以
数字-文件名称
的形式!!! - 最多支持
4
级文件结构!!! - 注意
.vitepress
和markdown
目录的位置
版权
yidocs
请任意使用,无任何额外要求,保留原作者信息即可。
反馈
- 作者微信:c91374286
- 作者邮箱:bimostyle@qq.com
其他
- @yicode/yite-cli(基于
vite
进行深度封装的vue3
项目开发脚手架) - @yicode/yiapi(基于
fastify
进行深度封装的nodejs
项目接口开发框架) - @yicode/dlnpm(
yicode
软件生态下载工具) - @yicode/commander(
commander v10
汉化,更符合国人使用) - @yicode/yidash(类
lodash
的业务方法库) - @yicode-helper/yidocs-auto(
vitepress
侧边栏和导航栏自动生成工具,避免手动配置) - @yicode-helper/yite-html(给基于
vite
项目开发提供不同环境下的入口文件) - @yicode-helper/yite-qrcode(开发时显示手机调试二维码,避免手动输入地址)
- @yicode-helper/yite-router(简单、粗暴、方便的路由自动化方案)
- @yicode-helper/yite-i18n(轻量级国际化语言数据生成插件)
- @yicode-helper/yite-chunk(代码自动分割方案)
- @yicode-template/base-vue3(基本且完整的
vue3
项目开发模板) - @yicode-template/yidocs(具备自动化侧边栏和导航栏的
vitepress
文档项目模板) - @yicode-template/uni-vue3(具备最新的依赖和项目组织的
uniapp vue3
项目模板) - @yicode-template/admin-vue3(
arco-design + vue3
研发的后台管理模板) - @yicode-template/yiapi-free(
yiapi
接口开发项目模板)

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
【MaxCompute】基于Package跨项目访问资源实践
背景 目前随着公司业务的不断扩展,各个业务线的数据也越来越多,如果所有数据都集中管理比较错综复杂。MaxCompute的跨项目访问资源比较适合这样的场景。每个业务线创建对应的project,自行管理数据。如果有需要访问其他业务线数据的诉求,可以基于Package实现数据共享的诉求,下面我们来介绍下基于Package实现跨项目访问资源的具体操作,本文以共享自建udf函数为例。 前期准备 MaxCompute项目projectA 和 projectB,详情参考 新建MaxCompute项目; 子账号 A(projectA开发环境任务发布人),详情参考 子账号创建; 子账号 B(projectA生产环境任务执行人,可为主账号或权限较高的子账号) ; 子账号 C(projectB跨项目访问人); projectA准备udf所有的jar包、表和函数,详情参考 MaxCompute udf。 步骤 账号权限明细 子账号 A(projectA开发环境任务发布人):普通开发人员 子账号 B(projectA生产环境任务执行人):除主账号外权限最高的管理者 子账号 C(projectB跨项目访问人):普...
- 下一篇
国产一站式数据库访问工具 CloudDM v2.0.5 发布,新增 ClickHouse 支持
CloudDM 是 ClouGence 公司推出的一款一站式多数据源开发管理工具,使用它可以方便地访问和管理 MySQL、Oracle、PostgreSQL、阿里云RDS、Greenplum、TiDB、Redis、StarRocks、Doris、SQL SERVER、ClickHouse 等多种不同类型的数据库。通过 CloudDM 丰富的数据源支持可以避免在多个专业工具之间切换,从而提高工作效率。 它是本地化的应用程序,没有后台进程。和 DataGrip、Navicat 一样在安装完成后,只需要双击应用程序图标,便可以方便的管理位于本地计算机或远程计算机上的数据库。已经支持 Windows 和 MacOS 两个操作系统。 更新内容 本次版本发布带来了大家较为关心的数据源和其他功能优化,更新内容如下: [新增] ClickHouse 数据源正式上线,并支持驱动版本选择 [新增] 右键菜单可以快速新增数据源、创建/删除库、清空/删除表、查看表结构等 [新增] 数据源列表可以看到数据库、Schema、表的数量 [新增] 支持 Apple MacOS M1/M2 平台 [修复] 修复 Pos...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS关闭SELinux安全模块
- CentOS7,8上快速安装Gitea,搭建Git服务器
- CentOS7,CentOS8安装Elasticsearch6.8.6
- Windows10,CentOS7,CentOS8安装MongoDB4.0.16
- CentOS6,CentOS7官方镜像安装Oracle11G
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- CentOS8编译安装MySQL8.0.19
- Windows10,CentOS7,CentOS8安装Nodejs环境
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- Hadoop3单机部署,实现最简伪集群