Skip to content

Commit c9c1837

Browse files
committed
docs: update documentation
1 parent 38fc81f commit c9c1837

File tree

3 files changed

+39
-30
lines changed

3 files changed

+39
-30
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
为了便于后续版本的维护与升级,我会定期发布 Learndata 的新版本,并在此记录所有破坏性更新及其他重要改动。
44

5+
## 1.3.7 (2025-01-24)
6+
7+
- 主题配置 `docs/.vuepress/theme.ts`
8+
- 更新 icon assets 配置:将 iconAssets 改为 plugins.icon.assets ([1cc3dc5](https://github.com/rockbenben/LearnData/commit/1cc3dc5c5a0a8b7443196e4e3f8b1034627bc4be))
9+
- 加密配置:对整个 encrypt 目录和指定页面加密的示例配置 ([38fc81f](https://github.com/rockbenben/LearnData/commit/38fc81f6c224f0cc2ae752d672e96c1fd15a9567))
10+
- 常规依赖升级 `package.json` ([fae924a](https://github.com/rockbenben/LearnData/commit/fae924a740419fb2b44fe909eacd7d01522ff1ed))
11+
512
## 1.3.6 (2024-12-09)
613

714
- 主题配置 `docs/.vuepress/theme.ts`

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828

2929
为此,我基于 VuePress 和 vuepress-theme-hope 构建了 LearnData 开源笔记,将我所有的笔记与文章聚合到同一页面形成知识库,便于集中管理和分享。
3030

31-
![](https://img.newzone.top/2022-08-22-19-28-25.png?imageMogr2/thumbnail/600x "笔记 + 文章 = LearnData 知识库")
31+
![](https://img.newzone.top/2022-08-22-19-28-25.png?imageMogr2/format/webp/thumbnail/600x "笔记 + 文章 = LearnData 知识库")
3232

33-
![](https://img.newzone.top/2022-08-24-19-14-59.png "笔记/博客自动化发布")
33+
![](https://img.newzone.top/2022-08-24-19-14-59.png?imageMogr2/format/webp "笔记/博客自动化发布")
3434

3535
## 🧱 笔记结构
3636

@@ -87,6 +87,7 @@ docs
8787
|── _posts # 博客文章目录
8888
├── _temp # 草稿箱
8989
├── reading # 读书笔记
90+
├── encrypt # 加密目录(可指定其他目录)
9091
├── anyname # 自定义笔记
9192
├── blog.md # 博客页面
9293
└── intro.md # 博主个人介绍
@@ -106,25 +107,25 @@ LearnData 集成了看板娘 [Live2D Widget](https://github.com/stevenjoezhang/l
106107

107108
如果网站部署在子页面 `https://xxx.github.io/yyy`,则需将子页面路径 yyy 加入到以下两个文件:
108109

109-
-`docs\.vuepress\public\live2d-widget\autoload.js` 文件第三行的 `const live2d_path = "/live2d-widget/"` 修改为 `const live2d_path = "/yyy/live2d-widget/"`
110-
-`docs\.vuepress\templateBuild.html` 文件中看板娘区块代码 `<script src="/live2d-widget/autoload.js">` 修改为 `<script src="/yyy/live2d-widget/autoload.js">`
110+
-`docs/.vuepress/public/live2d-widget/autoload.js` 文件第三行的 `const live2d_path = "/live2d-widget/"` 修改为 `const live2d_path = "/yyy/live2d-widget/"`
111+
-`docs/.vuepress/templateBuild.html` 文件中看板娘区块代码 `<script src="/live2d-widget/autoload.js">` 修改为 `<script src="/yyy/live2d-widget/autoload.js">`
111112

112-
如果你想要修改看板娘模型,请参考 `docs\.vuepress\public\live2d-widget` 路径下的 README 和修改说明。如果你想在服务器上自建 [live2d api](https://github.com/fghrsh/live2d_api),请注意添加跨域配置,否则可能会出现只显示文字而不显示看板娘图片的情况
113+
如需调整看板娘模型,请参照 `docs/.vuepress/public/live2d-widget` 目录下的 README 和修改说明。若在服务器上自建 [live2d api](https://github.com/fghrsh/live2d_api),请注意添加跨域配置,以避免仅显示文本而没有看板娘图片的情况。或者,可以使用我提供的看板娘 CDN,修改 `docs/.vuepress/public/live2d-widget/autoload.js` 中 initWidget 的 cdnPath,将 `cdnPath: live2d_path + "live2d_api/"` 更改为 `cdnPath: "https://live2d-api.aishort.top/"`
113114

114115
### 读书笔记
115116

116-
读书笔记中可能会有大量的原文引用,这与 LearnData 精简化知识点的初衷并不相符。因此,我们使用 docsify 来构建读书笔记,并将其放置于 `docs/reading` 目录下。在生成静态页面后,该路径下的文件不会被转换为 HTML 文件,而是将被自动复制到静态网站下,完成 docsify 页面构建和独立的读书笔记搜索索引
117+
由于读书笔记中可能包含大量原文引用,这与 LearnData 精简化知识点的初衷不符。我们选择使用 docsify 来构建读书笔记,这样读书笔记将与 LearnData 页面互不干扰,形成两个独立的搜索系统
117118

118-
由于读书笔记架构更换到 docsify,不能使用相对链接。请调整 `docs\.vuepress\sidebar.ts``{ text: "读书笔记", icon: "read", link: "https://newzone.top/reading/" }`,将 `newzone.top` 替换为你的博客域名。
119+
- **读书目录**:读书笔记存放在 `docs/reading` 目录下。该路径下的文件不会被转换为 HTML 文件,而是会自动复制到静态网站下,完成 docsify 页面构建和独立的读书笔记搜索索引。
120+
- 由于使用 docsify 架构,不能在 LearnData 网站内使用相对链接。请在 `docs/.vuepress/sidebar.ts` 中,将 `{ text: "读书笔记", icon: "read", link: "https://newzone.top/reading/" }` 中的 `newzone.top` 替换为你自己的博客域名,以确保链接正确。
121+
- **移除阅读统计**:如果你没有部署 Waline,或不需要统计阅读量和评论功能,可以移除 `docs/reading/index.html` 中的 Waline 配置代码块:
119122

120-
如果你没有部署 Waline,或不需统计阅读量和评论功能,可移除 `docs\reading\index.html` 中的 Waline 代码块。
121-
122-
```typescript
123-
waline: {
124-
serverURL: "https://waline.newzone.top",
125-
...
126-
}
127-
```
123+
```javascript
124+
waline: {
125+
serverURL: "https://waline.newzone.top",
126+
...
127+
}
128+
```
128129

129130
### 本地图片引用
130131

docs/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ icon: fa6-solid:book-open-reader
1616

1717
为此,我基于 VuePress 和 vuepress-theme-hope 构建了 LearnData 开源笔记,将我所有的笔记与文章聚合到同一页面形成知识库,便于集中管理和分享。
1818

19-
![](https://img.newzone.top/2022-08-22-19-28-25.png?imageMogr2/thumbnail/600x "笔记 + 文章 = LearnData 知识库")
19+
![](https://img.newzone.top/2022-08-22-19-28-25.png?imageMogr2/format/webp/thumbnail/600x "笔记 + 文章 = LearnData 知识库")
2020

21-
![](https://img.newzone.top/2022-08-24-19-14-59.png "笔记/博客自动化发布")
21+
![](https://img.newzone.top/2022-08-24-19-14-59.png?imageMogr2/format/webp "笔记/博客自动化发布")
2222

2323
## 🧱 笔记结构
2424

@@ -75,6 +75,7 @@ docs
7575
|── _posts # 博客文章目录
7676
├── _temp # 草稿箱
7777
├── reading # 读书笔记
78+
├── encrypt # 加密目录(可指定其他目录)
7879
├── anyname # 自定义笔记
7980
├── blog.md # 博客页面
8081
└── intro.md # 博主个人介绍
@@ -94,25 +95,25 @@ LearnData 集成了看板娘 [Live2D Widget](https://github.com/stevenjoezhang/l
9495

9596
如果网站部署在子页面(例如 `https://xxx.github.io/yyy`),则需要将子页面路径 yyy 加入到以下两个文件:
9697

97-
-`docs\.vuepress\public\live2d-widget\autoload.js` 文件第三行的 `const live2d_path = "/live2d-widget/"` 修改为 `const live2d_path = "/yyy/live2d-widget/"`
98-
-`docs\.vuepress\templateBuild.html` 文件中看板娘区块代码 `<script src="/live2d-widget/autoload.js">` 修改为 `<script src="/yyy/live2d-widget/autoload.js">`
98+
-`docs/.vuepress/public/live2d-widget/autoload.js` 文件第三行的 `const live2d_path = "/live2d-widget/"` 修改为 `const live2d_path = "/yyy/live2d-widget/"`
99+
-`docs/.vuepress/templateBuild.html` 文件中看板娘区块代码 `<script src="/live2d-widget/autoload.js">` 修改为 `<script src="/yyy/live2d-widget/autoload.js">`
99100

100-
如需调整看板娘模型,请参照 `docs\.vuepress\public\live2d-widget` 目录下的 README 和修改说明。若在服务器上自建 [live2d api](https://github.com/fghrsh/live2d_api),请注意添加跨域配置,以避免仅显示文本而没有看板娘图片的情况。或者,可以使用我提供的看板娘 CDN,修改 `docs\.vuepress\public\live2d-widget\autoload.js` 中 initWidget 的 cdnPath,将 `cdnPath: live2d_path + "live2d_api/"` 更改为 `cdnPath: "https://live2d-api.aishort.top/"`
101+
如需调整看板娘模型,请参照 `docs/.vuepress/public/live2d-widget` 目录下的 README 和修改说明。若在服务器上自建 [live2d api](https://github.com/fghrsh/live2d_api),请注意添加跨域配置,以避免仅显示文本而没有看板娘图片的情况。或者,可以使用我提供的看板娘 CDN,修改 `docs/.vuepress/public/live2d-widget/autoload.js` 中 initWidget 的 cdnPath,将 `cdnPath: live2d_path + "live2d_api/"` 更改为 `cdnPath: "https://live2d-api.aishort.top/"`
101102

102103
### 读书笔记
103104

104-
读书笔记中可能会有大量的原文引用,这与 LearnData 精简化知识点的初衷并不相符。因此,我们使用 docsify 来构建读书笔记,并将其放置于 `docs/reading` 目录下。在生成静态页面后,该路径下的文件不会被转换为 HTML 文件,而是将被自动复制到静态网站下,完成 docsify 页面构建和独立的读书笔记搜索索引
105+
由于读书笔记中可能包含大量原文引用,这与 LearnData 精简化知识点的初衷不符。我们选择使用 docsify 来构建读书笔记,这样读书笔记将与 LearnData 页面互不干扰,形成两个独立的搜索系统
105106

106-
由于读书笔记架构更换到 docsify,不能使用相对链接。请调整 `docs\.vuepress\sidebar.ts``{ text: "读书笔记", icon: "read", link: "https://newzone.top/reading/" }`,将 `newzone.top` 替换为你的博客域名。
107+
- **读书目录**:读书笔记存放在 `docs/reading` 目录下。该路径下的文件不会被转换为 HTML 文件,而是会自动复制到静态网站下,完成 docsify 页面构建和独立的读书笔记搜索索引。
108+
- 由于使用 docsify 架构,不能在 LearnData 网站内使用相对链接。请在 `docs/.vuepress/sidebar.ts` 中,将 `{ text: "读书笔记", icon: "read", link: "https://newzone.top/reading/" }` 中的 `newzone.top` 替换为你自己的博客域名,以确保链接正确。
109+
- **移除阅读统计**:如果你没有部署 Waline,或不需要统计阅读量和评论功能,可以移除 `docs/reading/index.html` 中的 Waline 配置代码块:
107110

108-
如果你没有部署 Waline,或不需统计阅读量和评论功能,可移除 `docs\reading\index.html` 中的 Waline 代码块。
109-
110-
```typescript
111-
waline: {
112-
serverURL: "https://waline.newzone.top",
113-
...
114-
}
115-
```
111+
```javascript
112+
waline: {
113+
serverURL: "https://waline.newzone.top",
114+
...
115+
}
116+
```
116117

117118
### 本地图片引用
118119

0 commit comments

Comments
 (0)