From 3ef8b4c0f96bb12e42092d76237b71308eca2ee5 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Fri, 9 Jun 2023 11:02:11 +0800 Subject: [PATCH] docs: refactor documentations of user guide (#225) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 重构用户指南的部分内容。 /kind documentation ```release-note None ``` --- docs/developer-guide/core/code-style.md | 2 +- docs/getting-started/first-post.md | 20 +- docs/user-guide/attachments.md | 60 +-- docs/user-guide/common.md | 33 +- docs/user-guide/config.md | 172 ------- docs/user-guide/faq.md | 51 +- docs/user-guide/markdown.md | 454 ------------------ docs/user-guide/pages.md | 31 +- docs/user-guide/plugins.md | 41 +- docs/user-guide/posts.md | 87 ++-- docs/user-guide/settings.md | 59 ++- docs/user-guide/themes.md | 40 +- docs/user-guide/users.md | 24 +- src/css/custom.css | 8 +- .../attachments/attachment-batch-operate.png | Bin 97177 -> 195276 bytes .../attachments/attachment-detail.png | Bin 0 -> 315510 bytes .../attachments/attachment-group-add.png | Bin 50736 -> 163015 bytes .../attachments/attachment-move.png | Bin 0 -> 171929 bytes .../attachment-policy-add-local.png | Bin 45781 -> 124157 bytes .../attachments/attachment-policy-add.png | Bin 79853 -> 130357 bytes .../attachments/attachment-policy-operate.png | Bin 31849 -> 111464 bytes .../attachments/attachment-upload.png | Bin 88045 -> 196915 bytes .../common/控制台界面说明.png | Bin 101415 -> 203087 bytes static/img/user-guide/pages/page-about.png | Bin 133868 -> 220220 bytes .../img/user-guide/plugins/plugin-install.png | Bin 129171 -> 238741 bytes .../img/user-guide/plugins/plugin-setting.png | Bin 74225 -> 134548 bytes .../img/user-guide/plugins/plugin-switch.png | Bin 129605 -> 227558 bytes .../user-guide/plugins/plugin-uninstall.png | Bin 65376 -> 247965 bytes .../img/user-guide/posts/category-create.png | Bin 140888 -> 222316 bytes static/img/user-guide/posts/category-move.gif | Bin 1554270 -> 2226039 bytes static/img/user-guide/posts/post-edit.png | Bin 168562 -> 279281 bytes static/img/user-guide/posts/post-setting.png | Bin 79214 -> 254041 bytes static/img/user-guide/posts/tag-create.png | Bin 123338 -> 196244 bytes static/img/user-guide/posts/tag-list.png | Bin 44689 -> 24269 bytes .../img/user-guide/settings/setting-basic.png | Bin 121348 -> 1189139 bytes .../img/user-guide/themes/theme-install.png | Bin 125561 -> 178975 bytes .../img/user-guide/themes/theme-setting.png | Bin 119346 -> 153486 bytes .../img/user-guide/themes/theme-uninstall.png | Bin 156805 -> 206030 bytes .../user-guide/users/auth-providers-entry.png | Bin 0 -> 151227 bytes .../img/user-guide/users/auth-providers.png | Bin 0 -> 173754 bytes static/img/user-guide/users/role-fork.png | Bin 50287 -> 133301 bytes .../img/user-guide/users/role-management.png | Bin 44341 -> 76958 bytes static/img/user-guide/users/user-operate.png | Bin 57914 -> 165436 bytes static/img/user-guide/users/user-setting.png | Bin 113708 -> 181133 bytes .../developer-guide/core/code-style.md | 2 +- .../version-2.6/getting-started/first-post.md | 20 +- .../version-2.6/user-guide/attachments.md | 60 +-- .../version-2.6/user-guide/common.md | 33 +- .../version-2.6/user-guide/config.md | 172 ------- versioned_docs/version-2.6/user-guide/faq.md | 51 +- .../version-2.6/user-guide/pages.md | 31 +- .../version-2.6/user-guide/plugins.md | 41 +- .../version-2.6/user-guide/posts.md | 87 ++-- .../version-2.6/user-guide/settings.md | 59 ++- .../version-2.6/user-guide/themes.md | 40 +- .../version-2.6/user-guide/users.md | 24 +- 56 files changed, 489 insertions(+), 1213 deletions(-) delete mode 100644 docs/user-guide/config.md delete mode 100644 docs/user-guide/markdown.md create mode 100644 static/img/user-guide/attachments/attachment-detail.png create mode 100644 static/img/user-guide/attachments/attachment-move.png create mode 100644 static/img/user-guide/users/auth-providers-entry.png create mode 100644 static/img/user-guide/users/auth-providers.png delete mode 100644 versioned_docs/version-2.6/user-guide/config.md diff --git a/docs/developer-guide/core/code-style.md b/docs/developer-guide/core/code-style.md index c4298a1..90bdd68 100644 --- a/docs/developer-guide/core/code-style.md +++ b/docs/developer-guide/core/code-style.md @@ -14,7 +14,7 @@ Halo 添加了 checkstyle 插件,来保证每位提交者代码的风格保持 - 进入 CheckStyle 配置(File | Settings | Tools | Checkstyle)。 - 选择 Checkstyle 版本:8.39。 -- 在配置文件中点击添加按钮,配置描述可随便填写(推荐 Halo Checks),选择 ./config/checkstyle/checkstyle.xml,点击下一步和完成; +- 在配置文件中点击添加按钮,配置描述可随便填写(推荐 Halo Checks),选择 ./config/checkstyle/checkstyle.xml,点击下一步和完成。 - 勾选刚刚创建的配置文件。 ## 配置 Editor diff --git a/docs/getting-started/first-post.md b/docs/getting-started/first-post.md index 31d1c85..6133c50 100644 --- a/docs/getting-started/first-post.md +++ b/docs/getting-started/first-post.md @@ -3,27 +3,25 @@ title: 第一篇文章 description: 安装完成后,如何写下第一篇文章。 --- -![第一篇文章](/img/first-post.gif) + +