https://github.com/1panel-dev/docs
1Panel docs
https://github.com/1panel-dev/docs
1panel
Last synced: 6 months ago
JSON representation
1Panel docs
- Host: GitHub
- URL: https://github.com/1panel-dev/docs
- Owner: 1Panel-dev
- License: gpl-3.0
- Created: 2022-11-30T03:56:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T10:34:08.000Z (6 months ago)
- Last Synced: 2025-04-07T11:32:12.449Z (6 months ago)
- Topics: 1panel
- Language: JavaScript
- Homepage: https://docs.1panel.pro
- Size: 79.1 MB
- Stars: 14
- Watchers: 5
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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)