Skip to content

如何贡献

欢迎参与本项目的建设!

贡献方式

  • 提交 Pull Request
  • 提出 Issue
  • 优化文档内容

本地开发指引

  1. 克隆仓库

    bash
    git clone https://github.com/LIUBINfighter/SUSTech-PHY104B-Yellow-Pages.git
    cd SUSTech-PHY104B-Yellow-Pages
  2. 安装依赖

    bash
    npm install
  3. 本地启动文档站点

    bash
    npm run docs:dev

    访问终端输出的本地地址即可预览文档。

  4. 构建生产环境静态文件

    bash
    npm run docs:build
  5. 预览构建结果

    bash
    npm run docs:preview

目录结构说明

  • docs/:文档内容与配置
  • package.json:项目依赖与脚本

贡献建议

  • 遵循已有文档结构,按需补充内容
  • 提交前请确保本地预览无误
  • 有问题欢迎通过 Issue 反馈

// ...可补充具体贡献流程和注意事项...