Commit eb5f939

author

Jacco-V

committed

Implement support for setting a customized sidebar item name from the markdown content

1 parent 1e46f2b commit eb5f939Copy full SHA for eb5f939

File tree

2 files changed

+10

-6

lines changed

docs
- helpers.md
src/core/render
- compiler.js

2 files changed

+10

-6

lines changed

`‎docs/helpers.md‎`

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -127,6 +127,12 @@ Only when you set both the `routerMode: 'history'` and `externalLinkTarget: '_se
`127`	`127`	`### Hello, world! :id=hello-world`
`128`	`128`	```
`129`	`129`
	`130`	`+## Customise item name for sidebar`
	`131`	`+`
	`132`	+```md
	`133`	`+### How would I write a "hello, world" example? :sidebar="Hello, world?"`
	`134`	+```
	`135`	`+`
`130`	`136`	`## Markdown in html tag`
`131`	`137`
`132`	`138`	`You need to insert a space between the html and markdown content.`

`‎src/core/render/compiler.js‎`

Lines changed: 4 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -207,38 +207,36 @@ export class Compiler {`
`207`	`207`	`*/`
`208`	`208`	`origin.heading = renderer.heading = function (text, level) {`
`209`	`209`	`let { str, config } = getAndRemoveConfig(text);`
`210`		`- const nextToc = { level,title: removeAtag(str) };`
	`210`	`+ const nextToc = { level };`
`211`	`211`
`212`	`212`	`if (/<!--{docsify-ignore}-->/g.test(str)) {`
`213`	`213`	`str = str.replace('<!-- {docsify-ignore} -->', '');`
`214`		`- nextToc.title = removeAtag(str);`
`215`	`214`	`nextToc.ignoreSubHeading = true;`
`216`	`215`	`}`
`217`	`216`
`218`	`217`	`if (/{docsify-ignore}/g.test(str)) {`
`219`	`218`	`str = str.replace('{docsify-ignore}', '');`
`220`		`- nextToc.title = removeAtag(str);`
`221`	`219`	`nextToc.ignoreSubHeading = true;`
`222`	`220`	`}`
`223`	`221`
`224`	`222`	`if (/<!--{docsify-ignore-all}-->/g.test(str)) {`
`225`	`223`	`str = str.replace('<!-- {docsify-ignore-all} -->', '');`
`226`		`- nextToc.title = removeAtag(str);`
`227`	`224`	`nextToc.ignoreAllSubs = true;`
`228`	`225`	`}`
`229`	`226`
`230`	`227`	`if (/{docsify-ignore-all}/g.test(str)) {`
`231`	`228`	`str = str.replace('{docsify-ignore-all}', '');`
`232`		`- nextToc.title = removeAtag(str);`
`233`	`229`	`nextToc.ignoreAllSubs = true;`
`234`	`230`	`}`
`235`	`231`
	`232`	`+ const title = config.sidebar \|\| str;`
`236`	`233`	`const slug = slugify(config.id \|\| str);`
`237`	`234`	`const url = router.toURL(router.getCurrentPath(), { id: slug });`
	`235`	`+ nextToc.title = removeAtag(title);`
`238`	`236`	`nextToc.slug = url;`
`239`	`237`	`_self.toc.push(nextToc);`
`240`	`238`
`241`		- return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" ><span>${str}</span></a></h${level}>`;
	`239`	+ return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${title}</span></a></h${level}>`;
`242`	`240`	`};`
`243`	`241`
`244`	`242`	`origin.code = highlightCodeCompiler({ renderer });`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit eb5f939

File tree

2 files changed

2 files changed

`‎docs/helpers.md‎`

`‎src/core/render/compiler.js‎`

0 commit comments