# Mkdocs_1Panel样式

**Repository Path**: grdnet/mkdocs1-panel-style

## Basic Information

- **Project Name**: Mkdocs_1Panel样式
- **Description**: Mkdocs_1Panel样式
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-21
- **Last Updated**: 2024-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

本仓库保存了 [1Panel 项目](https://github.com/1Panel-dev/1Panel) 的 [官方文档](https://1panel.cn/docs/)，该文档使用 [MkDocs](https://github.com/mkdocs/mkdocs) 文档框架下的 [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) 主题进行构建。

## 本地开发

### 克隆本仓库
```bash
git clone https://github.com/1Panel-dev/docs.git
```

### 安装依赖
```bash
cd docs
pip install -r requirements/requirements.txt
```

### 修改文档内容

本文档的文档结构定义在 `mkdocs.yml` 文件中，文档的具体内容均在 `docs` 目录中。

文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 `mkdocs.yml` 文件中的 `nav` 部分增加对应章节导航。

### 本地调试文档
```bash
mkdocs serve
```
执行上述命令后，可通过 `http://127.0.0.1:8000` 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。

### 构建文档
```bash
mkdocs build
```

执行上述命令后，会在 `site` 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。

## 问题反馈

如果您发现文档中存在错误，或对文档内容存在疑问，请提交 GitHub Issue 到 [1Panel 项目的主仓库](https://github.com/1Panel-dev/1Panel/issues)