Skip to content

Commit

Permalink
docs: add missing part of markdown.slugify
Browse files Browse the repository at this point in the history
  • Loading branch information
ulivz committed Nov 13, 2018
1 parent 15af271 commit 3e4bea6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/docs/docs/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,9 @@ Whether to show line numbers to the left of each code blocks.
### markdown.slugify

- Type: `Function`
- Default: [source](https://github.com/vuejs/vuepress/blob/master/lib/markdown/slugify.js)
- Default: [source](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/shared-utils/lib/slugify.js)

Function for transforming header texts into slugs. This affects the ids/links generated for header anchors, table of contents and sidebar links.
Function for transforming header texts into slugs. Changing this affects the ids/links generated for header anchors, table of contents and sidebar links.

### markdown.externalLinks

Expand Down
7 changes: 7 additions & 0 deletions packages/docs/docs/zh/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,13 @@ VuePress provides a convenient way to add extra styles. you can create an `.vuep

- [行号](../guide/markdown.md#行号)

### markdown.slugify

- Type: `Function`
- Default: [source](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/shared-utils/lib/slugify.js)

一个将标题文本转换为 slug 的函数。修改它会影响标题锚点、TOC、以及侧边栏链接生成的 id 和 链接。

### markdown.anchor

- 类型: `Object`
Expand Down

0 comments on commit 3e4bea6

Please sign in to comment.