---
url: /contributing/index.md
---
## 概览

项目仓库借助于 [pnpm 工作空间](https://pnpm.io/zh/workspaces) 来实现
[Monorepo](https://en.wikipedia.org/wiki/Monorepo) ，存放了多个互相关联的独立 Package 。

* 主题于 `theme` 目录中进行开发维护。
* 插件于 `plugins` 目录中进行开发维护。
* 文档于 `docs` 目录中进行开发维护。

在 `plugins` 目录中：

* `plugin-search`: 为主题提供 全文模糊搜索 功能
* `plugin-md-power`: 提供 markdown 增强功能
* `plugin-fonts`: 提供特殊字符字体支持

## 开发配置

开发要求：

* [Node.js](http://nodejs.org/) version 20.6.0+
* [pnpm](https://pnpm.io/zh/) version 9+

克隆代码仓库，并安装依赖：

```sh
pnpm install
```

在首次启动开发服务前，先构建源代码：

```sh
pnpm build
```

### 主要工具

* [TypeScript](https://www.typescriptlang.org/) 作为开发语言
* [ESLint](https://eslint.org/) 用于代码检查和格式化
* [StyleLint](https://stylelint.io/) 用于代码检查和格式化

### 脚本

#### `pnpm build`

`build` 命令使用 `tsc` 将源代码编译成 `lib` 目录下的 `.js` 文件。
同时复制 不需要编译的资源到对应的`lib` 目录下。

你在克隆代码仓库后，需要先执行该命令来确保项目代码可以顺利运行，因为编译后的输出目录被 `.gitignore` 排除在仓库以外了。

#### `pnpm dev`

`dev` 命令会在本地开启两个服务，一个是运行 主题 `theme` 目录的 `tsup:watch & copy:watch`,
一个是运行 示例 `docs` 目录的 `vuepress` 开发服务。

`plugins` 目录下的所有插件，默认都没有 `dev` 命令，因此，你对 `plugins` 下的改动，可能需要执行 `pnpm build` 命令
进行重新构建，部分对 `plugins/**/node` 目录下的改动，需要重新执行 `pnpm dev` 才能生效。

#### `pnpm lint`

`lint` 命令使用 ESLint 来检查所有源文件。

当 `lint` 给出了错误时，你可以手动修改源码以修复 eslint 的报错。
也可以执行 `pnpm lint:fix` 来自动修复。

#### `pnpm test`

`test` 命令使用 Vitest 来运行所有测试。

### IDE 支持

推荐使用 `vs code` 进行开发。本仓库配置了开发本主题时，推荐的 `vs code` 扩展，
当你导入本仓库时，`vs code` 可能会推荐你安装一些扩展。