ExamAware-docs/README.md
2025-02-01 15:49:41 +08:00

2.1 KiB
Raw Blame History

ExamAware 文档

这是 ExamAware 文档 仓库。本文档基于 VuePress 搭建,在线查看文档

开始编写文档

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

  2. 克隆并进入文档仓库

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

    pnpm install
    
  4. 启动 VuePress 服务器

    pnpm run docs:dev
    
  5. 在浏览器中键入终端输出的链接(默认是http://localhost:8080),即可浏览文档。当本地文档做出更改时,浏览器中的文档将自动刷新。

本文档使用了 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 许可协议授权。