Skip to content
This repository was archived by the owner on Nov 2, 2024. It is now read-only.

Commit c1b360b

Browse files
authored
docs: add readme and modify license autor (#4)
1 parent cfd2ddc commit c1b360b

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 Shu Ding
3+
Copyright (c) 2023 Mix Space
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Mix Space Documentation
2+
3+
## Contributing 贡献
4+
5+
这个站点使用的是 [Nextra](https://nextra.site/) 程序。站点内容使用 MDX 编写,文档文件都在 `pages` 文件夹中。如果只有一些简单的修改,你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request.
6+
7+
在本地开发中,[pnpm](https://pnpm.io/) 被选用为项目的包管理器,你需要使用 pnpm 安装依赖:
8+
9+
```bash
10+
pnpm i
11+
pnpm run dev
12+
pnpm run build
13+
pnpm run start
14+
```
15+
16+
## Working on the content 修改文字
17+
18+
- 关于支持的 MDX 扩展和在 MDX 内部使用 React 语法的能力,请参阅 Nextra 文档
19+
- 有关编写和维护文档内容的规则和建议,请参阅编写指南。
20+
21+
## Guide 编写指南
22+
23+
<u>**新增一个章节**</u>:
24+
25+
1. 克隆此项目
26+
2.`page` 文件夹中,新增一个文件夹,请语义化命名,假设为 `test`
27+
3. 编写内容,具体可以借鉴其他文档文件夹,请务必设置了父文件夹的 `_meta.json` 文件,具体请参考 Nextra 文档
28+
4. 创建 Pull Request. 其余审核的事情只需要交给我们来做就好了
29+
30+
**<u>编写内容的时候需要注意的事情</u>**
31+
32+
1. 中文与英文之间请保留一个空格,如`测试 test 测试`
33+
34+
## Author
35+
36+
docs © Mix Space Team, Released under MIT. Created on Jul 9, 2023

0 commit comments

Comments
 (0)