变更日志
该文件包含 vuepress-theme-hope
及其插件的所有显着更改。
# v1.27.1
- md-enhance: 添加了
lazyLoad
选项控制图片懒加载
# v1.27.0
# 代码块分组 breaking changes
你应该使用
:::: code-group
::: code-group-item title1
```text
code1
```
:::
::: code-group-item title2
```text
code1
```
:::
::::
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
来替代 <CodeGroup />
和 <CodeGroupItem />
。
它现在由 vuepress-plugin-md-enhance
中的 codegroup
选项所控制。
# v1.26.0
# 停止读取主题配置 config
现在大多插件不再读取 themeConfig
,所以使用者和调用主题必须直接传入所需选项。
# 评论组件重构 破坏性变更
<PageInfo />
已从评论插件中剥离, 评论插件现在会全局注册 <CommentService />
组件。
# 组件库重构 破坏性变更
<PageInfo />
提取到了 components 插件, 我们建议你使用 v-bind
指令传入它需要的属性。
Components 插件现在支持传入选项控制注册的插件,这样开发者能够完全控制使用哪些组件。
Components 插件现在支持 locales
选项。
# v1.25.0
# 自定义容器重做 新增
- md-enhance: 添加
container
和delay
选项 - md-enhance: rebuild container styles and add note container
# 其他
- photo-swipe: 添加
delay
选项 - theme: 添加
blog.autoExcerpt
选项
# v1.24.0
# 国际化支持 新增
下面的主题和插件支持通过 locales
选项配置国际化文字:
- comment
- copy-code
- md-enhance
- photo-swipe
- pwa
- reading-time
- theme
# v1.23.0
- 添加
zh-TW
和pt-BR
语言支持
# v1.22.0
同步支持 ts 配置文件 (来自 vuepress@1.9 的变更)
# v1.21.0
# 新功能
- 添加
ru-RU
和uk-UA
语言支持
# v1.20.4
# 新功能
theme: 为页脚添加国际化支持
现在你可以为每个语言设置不同的页脚
# v1.20.0
# 新功能
md-enhance: 重构代码演示
现在代码演示使用 Shadow DOM 提供样式隔离。
# v1.19.0
# 新功能
- active-hash 插件 新增
- smooth-scroll 插件 新增
# v1.18.0
# 新功能
添加自定义布局支持。
# v1.17.0
# 新功能
添加 Waline 支持。
# v1.16.0
# 新功能
# 图片链接修复 新增
现在,你可以在图片链接中使用特殊字符。这是一个针对 VuePress 内部 Bug 的修正。
此功能默认情况下处于启用状态,并由 imageFix
选项控制。
# 链接控制 新增
ThemeConfig 新增 cleanUrl
选项以更好地控制链接生成。
# 破坏变更 配置
ThemeConfig 中的 namedChunk
选项更名为 chunkRename
。
# v1.15.2
# 新功能
md-enhance: 为 mermaid 添加更多代码块
你现在可以在 Markdown 中使用如下代码块:
```sequence 顺序图表配置 ```
1
2
3```class 类图表配置 ```
1
2
3```state 状态图表配置 ```
1
2
3```er 入口关系图表配置 ```
1
2
3```gantt 甘特图表配置 ```
1
2
3```pie 饼图表配置 ```
1
2
3```journey 用户日志配置 ```
1
2
3theme: 页面 frontmatter 新增
anchorDisplay
选项
# v1.15.1
# 新功能
# 流程图的新语法
你可以除 flow
外使用
```flowchart
your flowchart...
```
2
3
生成流程图。
# 任务列表
md-enhance
插件中 tasklist
选项现在是可配置的:
interface TaskListOptions {
/**
* 是否使用 `<label>` 来包裹文字
*
* @default true
*/
label?: boolean;
/**
* 是否将 `<label>` 放置在 `<input>` 后还是包裹住 `<input>`
*
* @default true
*/
labelAfter?: boolean;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
# Tex
插件 md-enhance
中的 tex
现在是可配置的。 (作为KatexOptions
)
# v1.15.0
# 新功能
# Mermaid 新增
md-enhance
插件中新增 mermaid
选项以支持 mermaid 图表。
你可以使用:
```mermaid
your mermaid...
```
2
3
在你的 Markdown 中生成 mermaid 图表。
# 任务列表 新增
md-enhance
插件中新增 tasklist
选项以支持任务列表。
你可以在 Markdown 中使用 - [ ] 文字
或 - [x] 文字
来生成任务列表。
# v1.14.4
# 新功能
现在,体积较大的模块不仅会拆分为 chunks,而且只有在它们被使用时才输出到构建内容中。
这将有助于更好地控制打包体积。
# 破坏变更 配置
主题配置中的 docsBranch
从 'master'
更改为'main'
。
# v1.14.1
# 新功能 新增
vuepress-theme-hope
新增 themeConfig
、navbarConfig
和 sidebarConfig
辅助函数,以便在配置文件中提供更好的验证和自动补全功能。
# v1.14.0
# 破坏变更
# 流程图 语法
```flow preset
your flowchart...
```
2
3
更改为
```flow:preset
your flowchart...
```
2
3
# baselang 移除
所有的 baseLang
选项均被移除。
你应该使用 lang
键在 locales["/"]
中指定根目录语言。
# v1.13.4
# 新功能
- 博客首页新增
heroFullScreen
选项 - 导航栏新增
hideSiteTitleonMobile
选项 - 媒体图标新增 “电子邮件” 图标
# v1.13.3
# 新功能
添加德语支持。
# v1.13.0
# 破坏变更 语法
流程图语法从
@flowstart
你的流程图...
@flowend
2
3
改变为
```flow
你的流程图...
```
2
3
进行此更改是为了支持 Typora (opens new window)。
# v1.12.3
# 新功能 新增
新增 create-vuepress-theme-hope
包。
你可以使用 yarn create vuepress-theme-hope [dir]
或 npm init vuepress-theme-hope [dir]
轻松创建主题模板。
# v1.12.1
# 破坏变更 结构
主题的结构发生了变更,因此如果你正在扩展此主题,则可能需要更新代码。
# v1.12.0
# 新功能 新增
- 新增
git
插件 (opens new window) (@mr-hope/vuepress-plugin-git
) 🎉
# 破坏变更 移除
last-update
插件已移除
# v1.11.1
# 破坏变更 配置
- comment:
pageInfo
中的所有信息名称都从 PascalCase 更改为 kebab-case。且ReadTime
变更为reading-time
。
# v1.11.0
# 新功能
- theme: 博客模式新增
/star/
页面。所有收藏文章均在此页面上列出。
# 破坏变更 名称
- components:
<MyBadge>
重命名为<Badge>
,以对齐 VuePress 默认主题。
# v1.10.0
# 新功能 新增
components: 添加了
<CodeGroup>
和<CodeGroupItem>
组件。theme: 你可以在页面的 Frontmatter 中使用
star:true
为页面加注星标。星标页面都将出现在文章侧边栏中。
# v1.9.1
# 新功能 新增
- theme: 主题配置新增
blog.roundAvatar
(默认值:true
)
# v1.9.0
# 新功能 新增
新增 Feed 插件 (opens new window)。🎉
# 破坏变更 移除
- pwa: 移除
head
函数,使用 hacking 注入 PWA 链接。
# v1.8.2
# 破坏变更 移除
- md-enhance: 移除代码演示的
horizontal
选项
# v1.8.0
# 新功能 新增
- theme: 主题配置新增
namedChunks
选项
# v1.6.0
# 新功能 新增
- md-enhance: 新的代码演示功能 (opens new window) 🎉
# v1.5.4
# 新功能 新增
md-enhance: 添加两端对齐容器
::: justify 内容 :::
1
2
3
4
5
# v1.5.0
# 新功能 新增
last-update: 添加
timezone
选项当你通过 GitHub actions 上进行部署时,这很有用。(GitHub actions 使用
UTC
时区)md-enhance: 可以通过
presentation.plugins
选项配置幻灯片使用的插件theme: 添加 Font Awesome 图标支持
theme: 添加幻灯片布局
你可以在 Frontmatter 中使用
layout: Slide
来使用幻灯片布局。
# v1.4.7
# 新功能 新增
- pwa: 添加安装弹窗
# v1.4.5
# 新功能 新增
- pwa: 添加
maxPicSize
选项 - seo: 自动生成 robots.txt
# 破坏变更 配置
- pwa:
cacheMaxSize
重命名为maxSize
# v1.4.3
# 破坏变更 扩展名
pwa: Manifest 改用官方扩展名
Manifest 文件名从
manifest.json
更改为manifest.webmanifest
。
# v1.4.1
# 新功能 新增
- pwa: 新增
cacheHTML
选项
# v1.3.0
# 新功能 新增
- md-enhance: 通过 Reveal.js 添加幻灯片支持 🎉
# v1.2.0
# 新功能 新增
添加越南语支持。
# v1.1.0
# 破坏变更 API
theme: 将主题中的所有插件配置重命名为插件的 camelCase 名称:
addthis
重命名为addThis
markdown
更名为mdEnhance
lastUpdatedTransformer
重命名为lastUpdate
# v1.0.1
# 新功能 新增
- theme: 为媒体链接添加码云图标
# v1.0.0
# 破坏变更 API
- theme: 使用
const {config} = require('vuepress-theme-hope')
代替const resolve = require('vuepress-theme-hope / resolve')