https://github.com/eesast/docs

Last synced: 9 months ago
JSON representation

Host: GitHub
URL: https://github.com/eesast/docs
Owner: eesast
License: cc-by-sa-4.0
Created: 2020-11-13T16:19:32.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2025-01-20T05:44:46.000Z (over 1 year ago)
Last Synced: 2025-01-20T06:35:20.110Z (over 1 year ago)
Language: JavaScript
Homepage: https://docs.eesast.com
Size: 136 MB
Stars: 13
Watchers: 3
Forks: 21
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# EESΛST Docs

[![All Contributors](https://img.shields.io/badge/all_contributors-21-orange.svg?style=flat-square)](#contributors-)

使用 [Docusaurus 2](https://v2.docusaurus.io/) 构建，电子系科协以 [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) 授权开放的一系列工具与框架的使用指南。

## 命令

### 安装依赖

```console
yarn install
```

### 开发

```console
yarn start
```

### 构建静态文件

```console
yarn build
```

### 格式化和检查

本项目初步配置了 `eslint` 和 `prettier` 用于进行检查和格式化。由于项目主体为文档，不强求使用。建议编辑后使用 `yarn prettier` 进行格式化。

## 参与贡献

我们欢迎所有人参与此项目，包括且不限于：Issue、Pull Request

### Issue

Issue 用于提出问题、讨论功能改进、讨论文档内容改进等。提出 Issue 时，请务必检查以下几点：

- Issue 标题是否有明确的意义
- 是否已经有人提出了类似的 Issue

### Pull Request

Pull Request 用于将贡献者的修改合并到本项目的主分支中。我们遵循 `Fork & Pull` 开发流程，即所有参与贡献者需：

1. 总应 `fork` 本项目到个人仓库，如 `duskmoon/docs`
2. 建立一个具有明确意义名字的分支，如 `reactDoc`
3. 撰写文档（参照[文件结构](docs/intro/structure.mdx)），每一个 `commit` 都应具有可读的信息，如 `Add usage of useState() in react docs`
4. 提交一个具有明确意义标题的 Pull Request，如 `Add react docs`
5. 等待通过 CI 并有仓库的维护人员接受
6. 由 CI 或维护人员合并到主分支

对于 `git` 的使用，可以参看文档中相关部分。

## 贡献者 ✨

感谢诸位贡献者们 ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Campbell He}
💻 📖 🚇 🚧

_{Xiaoyang Ma}
📖

_lyz
📖

_{Xiangyu Li}
📖

_hukz18
📖

_{Jun Zhang}
📖

_Bowman
📖

_{DreamDraw Pan}
📖

_Yang-Xijie
📖

_{Timothy Liu}
📖 🚧 👀

_{Wang Zhiheng}
📖

_{Roy Chen}
📖

_Ther
📖

_Bx
📖

_TCL
📖

_{Boran Sun}
📖

_PLUTO-SCY
📖

_L0510410
📖 💻 🚧

_DragonAura
📖

_{Rosist Sallina}
📖

_{Xuc Pan}
📖