add mkdocs-material (#356)

Co-authored-by: BH1XAQ <tanxiao@16iot.cn>
This commit is contained in:
Xiao Tan 2023-11-06 18:23:05 +08:00 committed by GitHub
parent f858355a3b
commit dbfa47d70d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 90 additions and 0 deletions

View File

@ -0,0 +1,42 @@
<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material/">
<img src="https://ghproxy.com/https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" width="320" alt="Material for MkDocs">
</a>
</p>
<p align="center">
<strong>
基于
<a href="https://www.mkdocs.org/">MkDocs</a> 构建的一个强大的文档框架
</strong>
</p>
使用 Markdown 编写文档,在几分钟内为您的开源或商业项目创建一个专业的静态网站 —— 可搜索,可定制,支持 60 多种语言,适用于所有设备。
[Github 仓库](https://github.com/squidfunk/mkdocs-material)
[文档地址](https://squidfunk.github.io/mkdocs-material)
# Material for MkDocs 1Panel 版本使用帮助
## UI 展示
![](https://ghproxy.com/https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png)
## 工作目录
本应用会在 1panel 的应用目录生成 mkdocs-material 的工作目录,如果没有改 1panel 的工作目录的话,会是下面这个。
/opt/1panel/apps/local/mkdocs-material
## 项目目录
本应用支持创建多个项目,所以可以有多个项目目录,项目名称为安装时显示的名称。
例如,您创建的项目为 1p-docs则您可以在 `/opt/1panel/apps/local/mkdocs-material/1p-docs` 中的 docs 目录开始您的撰写。
## 默认端口
默认端口8111
您可以开启“高级设置 - 端口外部访问”,直接通过 8111 访问该文档项目。或使用反向代理功能,在不开启端口外部访问的情况下,反代这个文档项目。

View File

@ -0,0 +1,13 @@
additionalProperties:
key: mkdocs-material #应用的 key仅限英文用于在 Linux 创建文件夹
name: Material for MkDocs #应用名称
tags:
- Tool #应用标签,可以有多个,请参照下方的标签列表
shortDescZh: Markdown 文件托管平台 #应用中文描述,不要超过 30 个字
shortDescEn: Markdown File Hosting Platform #应用英文描述
type: tool #应用类型,区别于应用分类,只能有一个,请参照下方的类型列表
crossVersionUpdate: false #是否可以跨大版本升级
limit: 0 #应用安装数量限制0 代表无限制
website: https://github.com/squidfunk/mkdocs-material #官网地址
github: https://github.com/squidfunk/mkdocs-material #github 地址
document: https://squidfunk.github.io/mkdocs-material #文档地址

View File

@ -0,0 +1,10 @@
additionalProperties:
formFields:
- default: 8111
edit: true
envKey: PANEL_APP_PORT_HTTP
labelEn: Port
labelZh: 端口
required: true
rule: paramPort
type: number

View File

@ -0,0 +1,5 @@
# Hello World
你好,世界!
这是 MKDOCS 的默认页,你可以从这里开始。

View File

@ -0,0 +1,3 @@
site_name: 'MKDOCS - 1Panel'
theme:
name: material

View File

@ -0,0 +1,17 @@
version: '3'
services:
mkdocs-material:
image: squidfunk/mkdocs-material
container_name: ${CONTAINER_NAME}
restart: always
networks:
- 1panel-network
ports:
- "${PANEL_APP_PORT_HTTP}:8000"
volumes:
- ./data:/docs
labels:
createdBy: "Apps"
networks:
1panel-network:
external: true

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB