Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] feat: markdown.extractHeaders option #1730

Closed
wants to merge 3 commits into from
Closed

[WIP] feat: markdown.extractHeaders option #1730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75f7613
Allowing config option to set which headers to extract
bretterer Dec 16, 2018
733e9af
Passes in only siteConfig.markdown into markdown-loader
bretterer Jan 18, 2019
cf5d845
feat: markdown.extractHeaders option - specify the headers of extract…
ulivz Jul 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/@vuepress/core/lib/prepare/AppContext.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ module.exports = class AppContext {

this.base = this.siteConfig.base || '/'
this.themeConfig = this.siteConfig.themeConfig || {}
this.extractHeaders = this.siteConfig.markdown && this.siteConfig.markdown.extractHeaders

const rawOutDir = this.cliOptions.dest || this.siteConfig.dest
this.outDir = rawOutDir
Expand Down Expand Up @@ -292,6 +293,7 @@ module.exports = class AppContext {

async addPage (options) {
options.permalinkPattern = this.siteConfig.permalink
options.siteConfig = this.siteConfig
const page = new Page(options, this)
await page.process({
markdown: this.markdown,
Expand Down
9 changes: 6 additions & 3 deletions packages/@vuepress/core/lib/prepare/Page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ module.exports = class Page {
relative,
permalink,
frontmatter = {},
permalinkPattern
permalinkPattern,
extractHeaders = ['h2', 'h3']
}, context) {
this.title = title
this._meta = meta
Expand All @@ -54,6 +55,7 @@ module.exports = class Page {
this._permalink = permalink
this.frontmatter = frontmatter
this._permalinkPattern = permalinkPattern
this._extractHeaders = extractHeaders
this._context = context

if (relative) {
Expand Down Expand Up @@ -107,12 +109,13 @@ module.exports = class Page {
this.title = title
}

// headers
// extract headers
const headers = extractHeaders(
this._strippedContent,
['h2', 'h3'],
this._extractHeaders,
markdown
)

if (headers.length) {
this.headers = headers
}
Expand Down
3 changes: 2 additions & 1 deletion packages/@vuepress/core/lib/webpack/createBaseConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module.exports = function createBaseConfig ({
const inlineLimit = 10000

const config = new Config()
const extractHeaders = siteConfig.markdown && siteConfig.markdown.extractHeaders

config
.mode(isProd && !env.isDebug ? 'production' : 'development')
Expand Down Expand Up @@ -116,7 +117,7 @@ module.exports = function createBaseConfig ({
mdRule
.use('markdown-loader')
.loader(require.resolve('@vuepress/markdown-loader'))
.options({ sourceDir, markdown })
.options({ sourceDir, markdown, extractHeaders })

config.module
.rule('pug')
Expand Down
4 changes: 2 additions & 2 deletions packages/@vuepress/markdown-loader/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ module.exports = function (src) {
const isProd = process.env.NODE_ENV === 'production'
const isServer = this.target === 'node'
const options = getOptions(this)
const { sourceDir } = options
const { sourceDir, extractHeaders: extractHeadersPattern = ['h2', 'h3'] } = options
let { markdown } = options
if (!markdown) {
markdown = md()
Expand All @@ -42,7 +42,7 @@ module.exports = function (src) {

if (!isProd && !isServer) {
const inferredTitle = inferTitle(frontmatter.data, frontmatter.content)
const headers = extractHeaders(content, ['h2', 'h3'], markdown)
const headers = extractHeaders(content, extractHeadersPattern, markdown)
delete frontmatter.content

// diff frontmatter and title, since they are not going to be part of the
Expand Down
11 changes: 11 additions & 0 deletions packages/docs/docs/theme/default-theme-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,17 @@ module.exports = {
}
```

### Extract Headers
While preparing the page, headers are extracted from the markdown file and stored in `this.$page.headers`. By default, VuePress will extract `h2` and `h3` elements for you.
You can override the headers it pulls out in your `markdown` options.
``` js
module.exports = {
markdown: {
extractHeaders: [ 'h2', 'h3', 'h4' ]
}
}
```

### Active Header Links

By default, the nested header links and the hash in the URL are updated as the user scrolls to view the different sections of the page. This behavior can be disabled with the following theme config:
Expand Down