Skip to content

Commit

Permalink
docs: tweak the sequence of markdown options
Browse files Browse the repository at this point in the history
  • Loading branch information
ulivz committed Nov 13, 2018
1 parent 3e4bea6 commit c284a72
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/docs/docs/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,19 +210,19 @@ Whether to show line numbers to the left of each code blocks.

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
### markdown.anchor

- Type: `Object`
- Default: `{ target: '_blank', rel: 'noopener noreferrer' }`
- Default: `{ permalink: true, permalinkBefore: true, permalinkSymbol: '#' }`

The key and value pair will be added to `<a>` tags that points to an external link. The default option will open external links in a new window.
Options for [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor). (Note: prefer `markdown.slugify` if you want to customize header ids.)

### markdown.anchor
### markdown.externalLinks

- Type: `Object`
- Default: `{ permalink: true, permalinkBefore: true, permalinkSymbol: '#' }`
- Default: `{ target: '_blank', rel: 'noopener noreferrer' }`

Options for [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor). (Note: prefer `markdown.slugify` if you want to customize header ids.)
The key and value pair will be added to `<a>` tags that points to an external link. The default option will open external links in a new window.

### markdown.toc

Expand Down

0 comments on commit c284a72

Please sign in to comment.