Awesome-Class-Softwares-Web

这是 Awesome-Class-Softwares-Web 仓库，本站基于 VuePress 搭建，使用 VuePress Theme Hope 主题，查看在线网站。

开始编写文档

1. 安装 Node 20 环境（推荐使用NVM）

2. 克隆并进入文档仓库目录

3. 安装依赖（需要使用pnpm，可使用corepack安装）

   pnpm install

4. 启动 VuePress 服务器

   pnpm run docs:dev

5. 在浏览器中访问终端输出的链接（默认是http://localhost:8080），即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。

常用命令

命令	作用
pnpm run docs:build	构建项目，生成静态文件
pnpm run docs:clean-dev	启动开发服务器并清除缓存
pnpm run docs:dev	启动开发服务器，支持热更新
pnpm run docs:update-package	更新 VuePress 和相关依赖包
pnpm run export-pdf	将文档导出为 PDF 文件

本文档使用了 vuepress-plugin-md-enhance 的一些扩展语法，请尽量直接编辑 Markdown 文件，而不是使用可视化 Markdown 编辑器。建议使用 Visual Studio Code 编辑文档。

关于 VuePress 和 vuepress-plugin-md-enhance 的用法，请参见 VuePress 文档 和 vuepress-plugin-md-enhance 文档。

做出贡献

欢迎向本仓库提交 Pull Request。

许可证

本文档以 CC BY-NC-SA 4.0 许可协议授权。