Changelog

Mr.Hope ... 2021-4-27 About 4 min

This file contain all notable changes of vuepress-theme-hope and its plugins.

# v1.27.1

md-enhance: add lazyLoad option

# v1.27.0

# CodeGroup breaking changes

You should use

:::: code-group

::: code-group-item title1

```text
code1
```

:::

::: code-group-item title2

```text
code1
```

:::

::::

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

intead of <CodeGroup /> and <CodeGroupItem />, and it’s controlled by codegroup in vuepress-plugin-md-enhance.

# v1.26.0

# ThemeConfig reading config

Now most plugins no long read from themeConfig, so themes or users must directly set and pass options to plugins.

# Comment rebuild breaking changes

<PageInfo /> is extracted from comment plugin, and comment plugin now register <CommentService /> globally.

# Components rebuild breaking changes

<PageInfo /> is extracted to components plugin, and we recommand you to use v-bind directive to pass the props it needs.

Components now accept options to control component registing, so that developers can take full control of components they are using.

Also components now support locales options.

# v1.25.0

# Container Rebuild new

md-enhance: add container and delay option
md-enhance: rebuild container styles and add note container

# Others

photo-swipe: add delay options
theme: add blog.autoExcerpt

# v1.24.0

# Locales support new

Now the below plugins and theme support setting locales using locales option:

comment
copy-code
md-enhance
photo-swipe
pwa
reading-time
theme

# v1.23.0

add zh-TW and pt-BR language support

# v1.22.0

support ts config files with vuepress@1.9 change

# v1.21.0

# Features

add ru-RU and uk-UA language support

# v1.20.4

# Features

theme: add i18n support for footer

now you can set different footer for each loacle

# v1.20.0

# Features

md-enhance: rebuild code-demo

now code demo is using shadow dom to provide style isolation

# v1.19.3

# Features

seo: can generate summary for you automatically

# v1.19.0

# Features

active-hash plugin new
smooth-scroll plugin new

# v1.18.0

# Features

Add Custom layout support

# v1.17.0

# Features

Add Waline support

# v1.16.0

# Features

# Image Link fix new

Now you can use special characters when you are linking images. This is a workaround on VuePress internal bug.

This feature is on by default and controlled by imageFix option.

# Link Control new

New cleanUrl option in themeConfig to take better contorl of generating links.

# Breaking Changes config

namedChunk in themeConfig is renamed to chunkRename.

# v1.15.2

# Features

md-enhance: add more code blocks for mermaid

You can now use these code blocks in Markdown:

```sequence
sequence diagram here
```

1
2
3

```class
class diagram here
```

1
2
3

```state
state diagram here
```

1
2
3

```er
er diagram here
```

1
2
3

```gantt
gantt diagram here
```

1
2
3

```pie
pie diagram here
```

1
2
3

```journey
user journey here
```

1
2
3

theme: add anchorDisplay option in frontmatter

# v1.15.1

# Features

# New syntax for flowchart

```flowchart
your flowchart...
```

1
2
3

Can also generate a flowchart besides

```flow
your flowchart...
```

1
2
3

# Task List

tasklist in plugin md-enhance is now configurable

interface TaskListOptions {
  /**
   * Whether use `<label>` to wrap text
   *
   * @default true
   */
  label?: boolean;
  /**
   * Whether place `<label>` after `<input>` or wrap `<input>`
   *
   * @default true
   */
  labelAfter?: boolean;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# Tex

tex in plugin md-enhance is now configurable (as KatexOptions)

# v1.15.0

# Features

# Mermaid new

New mermaid option in plugin md-enhance to support mermaid diagram.

You should use

```mermaid
your mermaid...
```

1
2
3

In your Markdown to generate mermaid diagrams.

# Task List new

New tasklist option in plugin md-enhance to support task lists.

You should use - [ ] text or - [x] text in your Markdown to generatetask lists.

# v1.14.4

# Features

Now large modules will not only be splited in to chunks, they will be outputed only when they are used.

This will help make better control of bundle size.

# Breaking Changes config

docsBranch in themeConfig is changed from 'master' to 'main'.

# v1.14.1

# Features

# New helpers new

New helper functions themeConfig, navbarConfig and sidebarConfigin vuepress-theme-hope.

These are for better validatation and autocomplete in config file.

# v1.14.0

# Breaking Changes

# FlowChart syntax

```flow preset
your flowchart...
```

1
2
3

Is changed to

```flow:preset
your flowchart...
```

1
2
3

# baselang remove

All the baseLang options are removed.

You should specifc root folder language in locales["/"] using lang key.

# v1.13.4

# Features

New heroFullScreen option for blog homepage
New hideSiteTitleonMobile for navbar
New "Email" Icon for media icons

# v1.13.3

# Features

Add german language support.

# v1.13.0

# Breaking Changes syntax

Flowchart syntax is changed from

@flowstart
your flowchart...
@flowend

1
2
3

```flow
your flowchart...
```

1
2
3

This change is made to support Typora (opens new window).

# v1.12.3

# Features new

Add create-vuepress-theme-hope package.

You can use yarn create vuepress-theme-hope [dir] or npm init vuepress-theme-hope [dir] to create theme template easily.

# v1.12.1

# Breaking Changes structure

Theme components structure is changed.

If you are extending this theme, you may need to update your code.

# v1.12.0

# Features new

last-update plugin is removed
a new git plugin (opens new window) (@mr-hope/vuepress-plugin-git) 🎉

# v1.11.1

# Breaking Changes config

comment: All the info name in pageInfo is changed from PascalCase to kebab-case. And ReadTime is changed to reading-time.

# v1.11.0

# Features

theme: /star/ page is added in blog mode. All the star articles will be listed on this page.

# Breaking Changes name

components: Rename <MyBadge> to <Badge> to align @vuepress/theme-default.

# v1.10.0

# Features new

components: <CodeGroup> and <CodeGroupItem> is added.
theme: You can use star: true in frontmatter to star a page.

Star pages will appear in article sidebar.

# v1.9.1

# Features new

theme: blog.roundAvatar is added in themeConfig. (Default: true)

# v1.9.0

# Features new

new Feed plugin (opens new window). 🎉

# Breaking Changes drop

pwa: remove head function. We use hacking to inject PWA links for you.

# v1.8.2

# Breaking Changes drop

md-enhance: remove horizontal config for code-demo

# v1.8.0

# Features new

theme: new namedChunks options in themeConfig

# v1.6.0

# Features new

md-enhance: new Code Demo feature (opens new window) 🎉

# v1.5.4

# Features new

md-enhance: add justify align container
```
::: justify

content

:::
```
1
2
3
4
5

# v1.5.0

# Features new

last-update: add timezone option

This is useful when you are deploying on GitHub actions. (GitHub actions use UTC timezone)
md-enhance: you can config plugins for presentation now using presentation.plugins
theme: add Font Awesome icon support
theme: add Slides layout

You can use layout: Slide in frontmatter to use slide layout.

# v1.4.7

# Features new

pwa: add install modal

# v1.4.5

# Features new

pwa: add maxPicSize option
seo: auto generated robots.txt

# Breaking Changes config

pwa: cacheMaxSize rename to maxSize

# v1.4.3

# Breaking Changes ext

pwa: use official ext for manifest

Mmanifest filename change from manifest.json to manifest.webmanifest.

# v1.4.1

# Features new

pwa: add cacheHTML option

# v1.3.0

# Features new

md-enhance: add presentaion support using reveal.js 🎉

# v1.2.0

# Features i18n

Add Vietnamese support.

# v1.1.0

# Breaking Changes api

theme: Rename all the plugin config in theme to the camelcase version of plugin:
addthis renamed as addThis
markdown renamed as mdEnhance
lastUpdatedTransformer renamed as lastUpdate

# v1.0.1

# Features i18n

theme: add Gitee for MediaLink

# v1.0.0

# Breaking Changes api

theme: Use const { config } = require('vuepress-theme-hope') instead of const resolve = require('vuepress-theme-hope/resolve')

About VuePress

Common problems