From 3ed446bd032812e8776d1fea22d5974ce78ccf93 Mon Sep 17 00:00:00 2001 From: rockbenben Date: Sat, 21 Sep 2024 13:13:15 +0800 Subject: [PATCH] docs: update docs --- CHANGELOG.md | 10 ++++++++++ README.md | 4 ++-- docs/.vuepress/styles/index.scss | 13 ++++++------- docs/README.md | 10 +++++----- 4 files changed, 23 insertions(+), 14 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..0621f6d8c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Learndata 升级日志 + +为了便于后续版本的维护与升级，我会定期发布 Learndata 的新版本，并在此记录所有破坏性更新及其他重要改动。 + +## 1.3.5 + +- `docs\.vuepress\theme.ts`：修改配置中的 `plugins.mdEnhance`、`plugins.markdownImage`、`plugins.markdownHint`。 +- `docs\.vuepress\styles\palette.scss`：博客样式结构进行了大幅度的改版。此次改动后，可以直接替换此文件以更新样式。 +- `docs\.vuepress\templateBuild.html`：修改了网页模板 `head` 部分的样式定义，以适应新的页面布局和样式需求。 +- `package.json`：除了常规依赖项的升级，还新增了对 `sass-embedded` 的依赖。 diff --git a/README.md b/README.md index 0a401321e..b206126cc 100644 --- a/README.md +++ b/README.md @@ -215,7 +215,7 @@ Vercel 部署步骤如下： ### 本地运行 LearnData -1. 为了本地运行，你需要安装 npm 和 pnpm 环境，可参考[环境部署教程](https://newzone.top/deploy/VPS.html#环境部署)。 +1. 为了本地运行，你需要安装 npm 和 pnpm 环境，可参考[环境部署教程](https://newzone.top/deploy/vps/#环境部署)。 2. 将 LearnData 项目下载到本地后，在项目目录下打开终端，输入命令 `pnpm i` 安装依赖。 3. 在终端中输入命令 `pnpm docs:dev`，若成功则会提示访问链接，默认为 `http://localhost:8080/`。 @@ -223,7 +223,7 @@ Vercel 部署步骤如下： ## 🆙 版本升级 -通常情况下，你不需要升级 LearnData，除非出现依赖报错或需要使用新功能。版本升级时，除了 docs 目录外，所有内容都应使用最新版本的 LearnData 进行覆盖升级，`docs/.vuepress` 中的 `config.ts` 和 `theme.ts` 需要与新版文件进行比对，选择性更新。 +通常情况下，你不需要升级 LearnData，除非出现依赖报错或需要使用新功能。版本升级时，除了 docs 目录外，所有内容都应使用最新版本的 LearnData 进行覆盖升级，`docs/.vuepress` 中的 `config.ts` 和 `theme.ts` 需要与新版文件进行比对，选择性更新。升级日志请查看 [CHANGELOG.md](./CHANGELOG.md)。 以下是升级目录的说明： diff --git a/docs/.vuepress/styles/index.scss b/docs/.vuepress/styles/index.scss index eebe4451f..ac10a3aeb 100644 --- a/docs/.vuepress/styles/index.scss +++ b/docs/.vuepress/styles/index.scss @@ -1,6 +1,4 @@ // toc.scss, navbar.scss, sidebar.scss - -// 使用 CSS 的 @import 语法 @import "vidstack/player/styles/default/theme.css"; @import "vidstack/player/styles/default/layouts/audio.css"; @import "vidstack/player/styles/default/layouts/video.css"; @@ -10,12 +8,13 @@ top: calc(var(--navbar-height) + 5rem); } -#toc { +/* #toc { // 增加 toc 与内容区的距离 - // left: calc(100% + 2rem); + left: calc(100% + 2rem); // 隐藏目录文字「此页内容」 - // .toc-header { - // visibility: hidden; - // } + .toc-header { + visibility: hidden; + } } + */ \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 77a69aa7c..04ed8b832 100644 --- a/docs/README.md +++ b/docs/README.md @@ -90,14 +90,14 @@ docs ### 看板娘 -LearnData 集成了看板娘 [Live2D Widget](https://github.com/stevenjoezhang/live2d-widget)，支持随机对话、切换人物服饰和玩打飞机游戏，能提升网站美观度和趣味性。如果不需要看板娘，可以删除 `docs\.vuepress\public` 下的 live2d-widget 文件夹。 +LearnData 集成了看板娘 [Live2D Widget](https://github.com/stevenjoezhang/live2d-widget)，支持随机对话、切换人物服饰和玩打飞机游戏，能提升网站美观度和趣味性。如果不需要看板娘，可删除 `docs\.vuepress\public` 下的 live2d-widget 文件夹。 -如果网站部署在子页面 `https://xxx.github.io/yyy`，则需将子页面路径 yyy 加入到以下两个文件： +如果网站部署在子页面（例如 `https://xxx.github.io/yyy`），则需要将子页面路径 yyy 加入到以下两个文件： - 将 `docs\.vuepress\public\live2d-widget\autoload.js` 文件第三行的 `const live2d_path = "/live2d-widget/"` 修改为 `const live2d_path = "/yyy/live2d-widget/"`。 - 将 `docs\.vuepress\templateBuild.html` 文件中看板娘区块代码 `