Skip to content

提交书籍与纠正错误

Fork 我的仓库 并为我提出 Pull Request 或者请用 邮件 传送给我

本地安装与提交格式注意事项

请先安装:

安装项目依赖

sh
pnpm install

启动本地开发预览

sh
pnpm run dev

文章目录

其中分为 山、医、命、相、卜、相关经典 等文件夹

对应的就是 山篇、医篇、命篇、相篇、卜篇、相关经典 分类

请将书籍放置到相应的目录下


提交格式

书籍名称:请用原名称替代 例:道德经.md

(可选)书籍内容: 请在该书籍最上方注明书籍标题,并采用以下格式

md
---
title: 道德经
---

## 第 1 章

····

修改侧边栏显示书籍

进入 .vitepress/configs/sidebar.ts 目录

按照如下格式进行配置

ts
// .vitepress/configs/sidebar.ts
export function Sidelc() {
  return [
    {
      // text: '灵宠',
      // collapsed: true,
      base: '/灵宠/',
      items: [
        { text: '宠物篇', link: '宠物篇' },
        { text: '植物篇', link: '植物篇' }
      ]
    }
  ]
}

提示

  • text:分类名称 (请勿修改)
  • collapsed: 打开下拉开关选项(请勿修改)
  • base: 分类文件夹 (请勿修改)
  • items:该分类下的文件路径配置

新上传书籍 《宅经》 分类为 山篇

请将书籍拖动至 content/山 文件夹下

并且在 .vitepress/configs/sidebar.ts 添加侧边栏路径 配置如下:

ts
// 山篇
return [
  {
    // text: '灵宠',
    // collapsed: true,
    base: '/山篇/',
    items: [
      { text: '宅经', link: '宅经' }, 
      { text: '植物篇', link: '植物篇' }
    ]
  }
]

检查是否显示

做完上述步骤 运行

sh
pnpm run dev

ok 现在就可以看到提交的书籍在侧边栏显示了

赞助

贡献

欢迎提交 issuepull request,共同维护和更新文档。