PKU Puzzle Club 资料站

这是基于 Docusaurus 构建的 PKU Puzzle Club 资料站。

如何贡献？

如果您具有一定的代码开发和 GitHub 使用基础，可以直接 Pull Request。如果你不会操作但也想贡献内容，也可以直接联系我们提供原始内容， 由我们来更新，内容格式最好是 Markdown。

文件命名规范

对于内容相关的文件命名，应当遵循以下命名规范：

1. 文件名可用字符为[0-9a-z-_.]，词与词之间使用-连接，如果文件名是拼音则将每个字的拼音之间用-连接。
2. 每个文件的资源文件（图片等）放在同路径下的 {filename}.assets 文件夹下。资源文件的命名要么是有意义的字符串（描述图片内容），要么应当使用与文档中出现顺序一致的序号。
3. 文件后缀用 .md 和 .mdx 均可。为了方便使用纯 Markdown 的用户，目前的设置是以 .md 为后缀的文件视作普通 Markdown 文件，以 .mdx为后缀的文件会视作 mdx 格式。在绝大多数情况下使用 Markdown 格式的文件就足够了。还需要注意的一点是，在使用 .md 文件时，普通的 html 标签也不一定能正常使用，建议只使用 Markdown 语法。在目前使用的框架中，CommonMark 还是个实验性功能，详情请见 官方文档。

开发

安装依赖

我们使用 pnpm 管理依赖，pnpm-lock.yaml 文件也一并在项目中提供了。

$ pnpm install

本地开发

$ pnpm run start

这个命令会启动一个本地的开发服务器并且在浏览器中打开。 绝大多数文件更新都可以实时反映在页面上。

构建

$ pnpm run build

这个命令会构建出静态网站，默认输出到 build 目录。

开源协议

代码部分（src 文件夹下）使用 MIT 协议。 文档部分（docs 和 blog 文件夹下）使用 CC BY-NC 4.0 协议。