Skip to content

Commit

Permalink
compress images and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MR-Addict committed May 11, 2023
1 parent 0395929 commit 4991c51
Show file tree
Hide file tree
Showing 172 changed files with 806 additions and 654 deletions.
46 changes: 2 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,6 @@

## 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
Expand All @@ -20,40 +10,8 @@ npm start

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

## 2. 注意事项

### 2.1 前提和基础

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

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

### 2.2 Mardkown 规范

**安装插件**

写 Markdown 文档或者文章的时候,建议安装这两个插件以保证格式的统一性:

![markdown-plugin](./images/markdown-plugin.png)

**内容规范**

书写的内容请保证条理性和严谨性,书写的规范请参考已有的文章。

**压缩图片**

在 Markdown 中使用的图片最好先压缩再使用,图片不要超过 1M,建议在 **500K**左右,**越小越好**。你可以使用下面这个免费的在线压缩工具:

- [https://redketchup.io/image-compressor](https://redketchup.io/image-compressor)

### 2.3 格式化代码

提交前请先格式化代码再提交:

```
npm run format
```
更多详细内容请参考[网站文档](https://njtustas.github.io/docs/intro)的说明。

## 3. 访问链接
## 2. 访问链接

- [https://njtustas.github.io](https://njtustas.github.io)
6 changes: 3 additions & 3 deletions blog/stas-pc-maintenance-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ authors:

<img width="300" alt="2021-2022第一学年" src='/assets/images/stas-pc-maintenance/2021-2022第一学年.jpg'/>

作者:学姐朱逸云 <br/> 时间:2021-2022 第一学年
作者:朱逸云学姐 <br/> 时间:2021-2022 第一学年

---

Expand All @@ -70,14 +70,14 @@ authors:

<img width="300" alt="2022-2023第一学年" src='/assets/images/stas-pc-maintenance/2022-2023第一学年.png'/>

作者:学姐朱逸云 <br/> 时间:2022-2023 第一学年
作者:朱逸云学姐 <br/> 时间:2022-2023 第一学年

---

**第二学年**

<img width="300" alt="2022-2023第二学年" src='/assets/images/stas-pc-maintenance/2022-2023第二学年.png'/>

作者:学姐朱逸云 <br/> 时间:2022-2023 第二学年
作者:朱逸云学姐 <br/> 时间:2022-2023 第二学年

---
44 changes: 44 additions & 0 deletions config/footer.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
const footer = [
{
title: "文档",
items: [
{
label: "文章动态",
to: "/blog"
},

{
label: "电子组文档",
to: "/docs/electronics"
}
]
},
{
title: "资源",
items: [
{
label: "南工OJ",
href: "https://acm.online.njtech.edu.cn"
},
{
label: "值班笔记",
href: "https://punch.mraddict.top"
}
]
},
{
title: "友链",
items: [
{
label: "远景实验室",
href: "https://www.vistalab.top"
},
{
label: "Mars工作室",
href: "https://studio.online.njtech.edu.cn"
}
]
}
];

module.exports = footer;
Loading

0 comments on commit 4991c51

Please sign in to comment.