提交书籍与纠错.md

title
提交书籍与纠错

提交书籍

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

纠正错误

请在这里提出 issues | 或者请给我发邮件

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

本站点采用的 VitePress 建造

请先安装依赖:

Node.js 版本 18 或更高版本。

安装 pnpm 包管理器

::: code-group

iwr https://get.pnpm.io/install.ps1 -useb | iex

brew install pnpm

:::

安装项目依赖

pnpm install

---

启动本地开发预览

pnpm run dev

---

文章目录

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

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

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

---

提交格式

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

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

---
title: 道德经
---

## 第 1 章

····

---

修改侧边栏显示书籍

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

按照如下格式进行配置

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

:::tip

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

例

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

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

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

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

检查是否显示

做完上述步骤 运行

pnpm run dev

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

赞助

贡献

欢迎提交 issue 和 pull request，共同维护和更新文档。

<script setup> import { VPTeamMembers } from 'vitepress/theme' import { socialLinks } from '../.vitepress/configs/index.ts' const members = [ { avatar: 'https://www.github.com/Theo-messi.png', name: 'Theo-Messi', title: 'Author', links: socialLinks, }, ] </script>