/official-website

现代化 TypeScript 站点

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Site CI pr badgen last commit contributors All Contributors

国内 GitHub 访问缓慢问题解决方案:https://github.com/521xueweihan/GitHub520

简介

这里是桂林电子科技大学数学与计算科学学院创新创业实践基地的官方站点。站点基于 Facebook 开源站点生成器 Docusaurus 构建,当前使用版本:2.0.0-beta.18。项目使用 GitHub Action 进行 CI/CD。

项目的 GitHub Actions 简介 - .github/intro.md)

参与站点的维护

加入站点的维护并无任何门槛,你只需要懂那么一点点的 Git 操作「即可参与站点文档部分的维护」,还不熟悉 Git 协作的同学可到此练习仓练习 -> Git2Github-practice

加入站点的开发还是微微有点门槛的,熟悉 Web 前端(特别是熟悉 React)的同学,读个文档就能快速上手,对站点进行定制开发。具体可以参考 Docusaurus@v2 官方文档 -> 🔗v2.docusaurus🌹

开发环境说明

你可以选用 yarn 或 npm 任意一款包管理工具进行本地开发。

Node.js 版本 >= 10.15.1,Yarn 版本 >= 1.22.10

# 安装 yarn
npm install -g yarn

参与贡献

以下示范基于基地项目 ——> Git2Github-practice 的协作之道

git clone https://github.com/your-username/official-website
cd official-website
  • Step 2:新建 Git 分支,基于新分支进行开发
git branch branch-name

安装项目依赖

yarn
# or
npm install
  • Step 3:启动开发服务器,进行开发
yarn run start
# or
npm run start
  • Step 4:将变更提交至 GitHub,然后向本仓库(main branch)发起 pull reqeust
git add .
git commit -m "feat: xxxxxx"
git push origin branch-name

贡献者 ✨

Thanks goes to these wonderful people (emoji key):


redhat123456

📖 🚧

Sustart

📖

Higgins995

📖 🐛

Z233

💻

lideming

💻 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!