初始提交
This commit is contained in:
37
README.md
Normal file
37
README.md
Normal file
@ -0,0 +1,37 @@
|
||||
# MTTU docs
|
||||
|
||||
只要编辑就好。你不需要什么其他的东西。
|
||||
|
||||
## 如果你是开发者
|
||||
|
||||
### 环境配置
|
||||
|
||||
```bash
|
||||
uv venv
|
||||
source ./.venv/bin/activate.fish # 如果你在 fish
|
||||
uv install
|
||||
```
|
||||
|
||||
如果你不用 fish,或者觉得直接安装所有东西也没事:
|
||||
|
||||
```bash
|
||||
pip install mkdocs watchfiles
|
||||
```
|
||||
|
||||
### Dev
|
||||
|
||||
运行一个 Dev 服务器以查看效果
|
||||
|
||||
```bash
|
||||
watchfiles "mkdocs serve" ./docs
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
mkdocs build
|
||||
```
|
||||
|
||||
### 文档
|
||||
|
||||
见 [mkdocs 文档](https://www.mkdocs.org/user-guide/writing-your-docs/)
|
||||
Reference in New Issue
Block a user