From 194b097929bb4e5ea1eb8871805518f5ff3fcb97 Mon Sep 17 00:00:00 2001 From: wanghe-fit2cloud Date: Mon, 6 Nov 2023 22:07:19 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=A2=9E=E5=8A=A0=20mkdocs=20=E5=BA=94?= =?UTF-8?q?=E7=94=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- mkdocs-material/{latest => 9.4.8}/data.yml | 0 .../{latest => 9.4.8}/data/docs/index.md | 0 .../{latest => 9.4.8}/data/mkdocs.yml | 0 .../{latest => 9.4.8}/docker-compose.yml | 2 +- mkdocs-material/README.md | 46 ++++--------------- mkdocs-material/data.yml | 29 +++++++----- 6 files changed, 28 insertions(+), 49 deletions(-) rename mkdocs-material/{latest => 9.4.8}/data.yml (100%) rename mkdocs-material/{latest => 9.4.8}/data/docs/index.md (100%) rename mkdocs-material/{latest => 9.4.8}/data/mkdocs.yml (100%) rename mkdocs-material/{latest => 9.4.8}/docker-compose.yml (82%) diff --git a/mkdocs-material/latest/data.yml b/mkdocs-material/9.4.8/data.yml similarity index 100% rename from mkdocs-material/latest/data.yml rename to mkdocs-material/9.4.8/data.yml diff --git a/mkdocs-material/latest/data/docs/index.md b/mkdocs-material/9.4.8/data/docs/index.md similarity index 100% rename from mkdocs-material/latest/data/docs/index.md rename to mkdocs-material/9.4.8/data/docs/index.md diff --git a/mkdocs-material/latest/data/mkdocs.yml b/mkdocs-material/9.4.8/data/mkdocs.yml similarity index 100% rename from mkdocs-material/latest/data/mkdocs.yml rename to mkdocs-material/9.4.8/data/mkdocs.yml diff --git a/mkdocs-material/latest/docker-compose.yml b/mkdocs-material/9.4.8/docker-compose.yml similarity index 82% rename from mkdocs-material/latest/docker-compose.yml rename to mkdocs-material/9.4.8/docker-compose.yml index a5940b991..126edc33d 100644 --- a/mkdocs-material/latest/docker-compose.yml +++ b/mkdocs-material/9.4.8/docker-compose.yml @@ -1,7 +1,7 @@ version: '3' services: mkdocs-material: - image: squidfunk/mkdocs-material + image: squidfunk/mkdocs-material:9.4.8 container_name: ${CONTAINER_NAME} restart: always networks: diff --git a/mkdocs-material/README.md b/mkdocs-material/README.md index 155795765..3bfe98e54 100644 --- a/mkdocs-material/README.md +++ b/mkdocs-material/README.md @@ -1,42 +1,14 @@ -

- - Material for MkDocs - -

+# 使用帮助 -

- - 基于 - MkDocs 构建的一个强大的文档框架 - -

+进入 `/opt/1panel/apps/mkdocs-material/mkdocs-material/data/docs` 目录，开始您的撰写。 -使用 Markdown 编写文档，在几分钟内为您的开源或商业项目创建一个专业的静态网站 —— 可搜索，可定制，支持 60 多种语言，适用于所有设备。 +# Material for MkDocs -[Github 仓库](https://github.com/squidfunk/mkdocs-material) +**MkDocs** 是一个快速、简单且华丽的静态站点生成器，适用于构建项目文档。文档源文件是用 Markdown 编写的，并使用单个 YAML 配置文件进行配置。 -[文档地址](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 访问该文档项目。或使用反向代理功能，在不开启端口外部访问的情况下，反代这个文档项目。 \ No newline at end of file +- 很棒的主题可供选择：MkDocs有一堆好看的主题可供使用。在内置主题之间进行选择： mkdocs和 readthedocs，选择第三方主题之一（在MkDocs 主题wiki 页面以及MkDocs Catalog上），或者构建您自己的. +- 易于定制：通过自定义主题和/或安装一些插件 ，让您的项目文档看起来就像您想要的那样 。使用Markdown 扩展修改 Markdown 的行为。有许多配置选项可用。 +- 在工作时预览您的网站：内置的开发服务器允许您在编写文档时预览文档。每当您保存更改时，它甚至会自动重新加载并刷新您的浏览器。 +- 随处托管：MkDocs 构建完全静态的 HTML 站点，您可以将其托管在 GitHub Pages、Amazon S3 或您选择的任何其他地方。 \ No newline at end of file diff --git a/mkdocs-material/data.yml b/mkdocs-material/data.yml index 1be43b1a8..2de75c724 100644 --- a/mkdocs-material/data.yml +++ b/mkdocs-material/data.yml @@ -1,13 +1,20 @@ +name: Material for MkDocs +tags: + - 实用工具 +title: Markdown 文件托管平台 +type: 实用工具 +description: Markdown 文件托管平台 additionalProperties: - key: mkdocs-material #应用的 key，仅限英文，用于在 Linux 创建文件夹 - name: Material for MkDocs #应用名称 + key: mkdocs-material + 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 #文档地址 + - Tool + shortDescZh: Markdown 文件托管平台 + shortDescEn: A powerful documentation framework on top of MkDocs + type: tool + crossVersionUpdate: false + limit: 0 + recommend: 0 + website: https://squidfunk.github.io/mkdocs-material/ + github: https://github.com/squidfunk/mkdocs-material + document: https://squidfunk.github.io/mkdocs-material/getting-started/ \ No newline at end of file