BiliBiliTool.Docs 项目教程

1. 项目的目录结构及介绍

BiliBiliTool.Docs 项目的目录结构如下：

BiliBiliTool.Docs/
├── README.md
├── docs/
│   ├── _coverpage.md
│   ├── _navbar.md
│   ├── _sidebar.md
│   ├── configuration.md
│   ├── deployment.md
│   ├── faq.md
│   ├── index.md
│   ├── installation.md
│   ├── usage.md
│   └── ...
├── .gitignore
├── .github/
│   └── workflows/
│       └── ci.yml
├── .vuepress/
│   ├── config.js
│   └── public/
│       └── images/
└── package.json

目录结构介绍

• README.md: 项目的主介绍文件。
• docs/: 存放文档的目录。
  • _coverpage.md: 文档封面页。
  • _navbar.md: 导航栏配置文件。
  • _sidebar.md: 侧边栏配置文件。
  • configuration.md: 配置文件相关文档。
  • deployment.md: 部署相关文档。
  • faq.md: 常见问题解答。
  • index.md: 主页文档。
  • installation.md: 安装指南。
  • usage.md: 使用指南。
• .gitignore: Git 忽略文件配置。
• .github/: GitHub 相关配置。
  • workflows/: GitHub Actions 工作流配置。
• .vuepress/: VuePress 配置目录。
  • config.js: VuePress 主配置文件。
  • public/: 静态资源目录。
• package.json: Node.js 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 .vuepress/config.js，它是 VuePress 的主配置文件，负责配置文档的展示和行为。

.vuepress/config.js 文件介绍

module.exports = {
  title: 'BiliBiliTool 文档',
  description: 'BiliBiliTool 的使用和配置文档',
  base: '/BiliBiliTool.Docs/',
  themeConfig: {
    nav: [
      { text: '首页', link: '/' },
      { text: '安装', link: '/installation' },
      { text: '使用', link: '/usage' },
      { text: '配置', link: '/configuration' },
      { text: '部署', link: '/deployment' },
      { text: '常见问题', link: '/faq' },
    ],
    sidebar: 'auto',
  },
};

启动文件功能

• title: 设置文档的标题。
• description: 设置文档的描述。
• base: 设置文档的基础路径。
• themeConfig: 配置主题相关的设置，包括导航栏和侧边栏。

3. 项目的配置文件介绍

项目的配置文件主要有两个：.vuepress/config.js 和 docs/configuration.md。

.vuepress/config.js 配置文件介绍

如上所述，.vuepress/config.js 是 VuePress 的主配置文件，负责配置文档的展示和行为。

docs/configuration.md 配置文件介绍

docs/configuration.md 文件详细介绍了项目的配置选项和方法。

# 配置

## 环境变量

BiliBiliTool 使用环境变量进行配置。以下是一些常用的环境变量：

- `BILIBILI_COOKIE`: BiliBili 的 Cookie 信息。
- `BILIBILI_PUSH_KEY`: 推送服务的 Key。
- `BILIBILI_CRON`: 定时任务的 Cron 表达式。

## 配置示例

```env
BILIBILI_COOKIE=your_cookie_here
BILIBILI_PUSH_KEY=your_push_key_here
BILIBILI_CRON=0 0 0 * * ?

配置说明

• BILIBILI_COOKIE: 用于登录 BiliBili 的 Cookie