Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MR-Addict committed May 11, 2023
1 parent c955c9a commit 0395929
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,31 @@

## 1. 项目开发

开发项目:
安装 Git,前往 [Git 官网](https://git-scm.com/downloads)下载安装。

安装 Node,需要有 Node16 及以上的版本,建议安装 **Node18**,你可以前往 [Node 官网](https://nodejs.org)下载安装。

克隆项目:

```sh
git clone https://github.com/NJTUSTAS/njtustas.github.io.git
```

开发项目:

```sh
npm start
```

启动后会自动跳转至[http://localhost:3000](http://localhost:3000)
启动后浏览器会自动跳转至[http://localhost:3000](http://localhost:3000)

## 2. 注意事项

### 2.1 前提和基础

首先你需要有使用 Git、Github 的经验,会写 Markdown。

另外,本项目使用的文档框架是[Docusaurus](https://docusaurus.io/),也是由 Facebook 领导开发的一个开源项目,底层使用的是 React 和 Webpack,开发前建议先阅读一下相关文档。如果你要开发独立的页面,需要了解 React 和 Typescript;如果只是写文档和文章,只需要知道这个框架的结构,会写 Markdown 就可以了。
另外,本项目使用的文档框架是[Docusaurus](https://docusaurus.io/),也是由 Facebook 领导开发的一个开源项目,底层使用的是 React 和 Webpack,开发前建议先阅读一下他们的文档。如果你要开发独立的页面,需要了解 React 和 Typescript;如果只是写文档和文章,只需要知道这个框架的结构,会写 Markdown 就可以了。

### 2.2 Mardkown 规范

Expand Down

0 comments on commit 0395929

Please sign in to comment.