增加文档
This commit is contained in:
@@ -13,13 +13,13 @@
|
||||
|
||||
使用三个反引号包裹代码,并指定语言:
|
||||
|
||||
````markdown
|
||||
```markdown
|
||||
```python
|
||||
def hello():
|
||||
print("Hello, World!")
|
||||
```
|
||||
````
|
||||
|
||||
```
|
||||
### 链接
|
||||
|
||||
- 内部链接:使用相对路径
|
||||
@@ -53,6 +53,7 @@ def hello():
|
||||
### 文档头部
|
||||
|
||||
每个文档应包含:
|
||||
|
||||
- 标题(H1)
|
||||
- 简要描述
|
||||
- 目录(可选,用于长文档)
|
||||
@@ -101,4 +102,3 @@ def hello():
|
||||
- 2024-01-01: 初始版本
|
||||
- 2024-01-15: 添加新功能说明
|
||||
```
|
||||
|
||||
|
||||
@@ -26,27 +26,31 @@ docker-compose up -d
|
||||
## 常用命令
|
||||
|
||||
### 启动服务
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### 停止服务
|
||||
|
||||
```bash
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
### 查看日志
|
||||
|
||||
```bash
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
### 构建静态站点
|
||||
|
||||
```bash
|
||||
docker-compose exec mkdocs mkdocs build
|
||||
```
|
||||
|
||||
### 进入容器
|
||||
|
||||
```bash
|
||||
docker exec -it mkdocs sh
|
||||
```
|
||||
|
||||
|
||||
@@ -20,6 +20,7 @@ mkdocs/
|
||||
### mkdocs.yml
|
||||
|
||||
MkDocs 的主配置文件,包含:
|
||||
|
||||
- 站点信息(名称、描述、作者等)
|
||||
- 主题配置
|
||||
- 插件配置
|
||||
@@ -29,6 +30,7 @@ MkDocs 的主配置文件,包含:
|
||||
### docker-compose.yml
|
||||
|
||||
Docker Compose 配置文件,定义:
|
||||
|
||||
- 使用的镜像
|
||||
- 端口映射
|
||||
- 数据卷挂载
|
||||
@@ -41,4 +43,3 @@ Docker Compose 配置文件,定义:
|
||||
2. **命名规范**: 使用有意义的文件名
|
||||
3. **导航清晰**: 在 `mkdocs.yml` 中维护清晰的导航结构
|
||||
4. **版本控制**: 建议使用 Git 管理文档
|
||||
|
||||
|
||||
Reference in New Issue
Block a user