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

feature: support customized sidebar item name from content #1825

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from
Open

feature: support customized sidebar item name from content #1825

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
eb5f939
Implement support for setting a customized sidebar item name from the…
Jun 22, 2022
a764b02
Push both title and label to toc (=table of contents) array
Jun 23, 2022
cfca427
Apply changes to duplicate code block
Jun 23, 2022
cdca395
Apply new functionality to doc file
Jun 23, 2022
f536e72
Refactor for better readability
Jun 23, 2022
e581df7
Support quoted strings for config value arguments
Jun 23, 2022
27513e0
Update render-util tests
Jun 23, 2022
cf9e00b
replace function chaining with more modified regex
Jun 23, 2022
83e5795
replace 'label' with 'text' for more intuitive variable naming
Jul 4, 2022
b838fc3
Fix incorrect (escaped) quoted string parsing
Jul 4, 2022
da7937e
Fix logic for html-escaped str argument
Jul 4, 2022
d66d22d
Fix test arguments to match reality
Jul 4, 2022
71288be
Change test to provide html-escaped string
Jul 4, 2022
79e738a
Change regex to work directly on html-escaped string
Jul 4, 2022
a6333ec
Add support for marked.md `smartypants` 'smart' quotes
Jul 4, 2022
5a1e655
Merge branch 'develop' into feature-customizableSidebarItemName
Koooooo-7 Aug 30, 2022
03fda8b
Merge branch 'develop' into feature-customizableSidebarItemName
jhildenbiddle Sep 12, 2022
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
6 changes: 6 additions & 0 deletions docs/helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,12 @@ Only when you set both the `routerMode: 'history'` and `externalLinkTarget: '_se
### Hello, world! :id=hello-world
```

## Customise item name for sidebar

```md
### How would I write a "hello, world" example? :sidebar="Hello, world?"
```

## Markdown in html tag

You need to insert a space between the html and markdown content.
Expand Down
10 changes: 4 additions & 6 deletions src/core/render/compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,38 +207,36 @@ export class Compiler {
*/
origin.heading = renderer.heading = function (text, level) {
let { str, config } = getAndRemoveConfig(text);
const nextToc = { level, title: removeAtag(str) };
const nextToc = { level };

if (/<!-- {docsify-ignore} -->/g.test(str)) {
str = str.replace('<!-- {docsify-ignore} -->', '');
nextToc.title = removeAtag(str);
nextToc.ignoreSubHeading = true;
}

if (/{docsify-ignore}/g.test(str)) {
str = str.replace('{docsify-ignore}', '');
nextToc.title = removeAtag(str);
nextToc.ignoreSubHeading = true;
}

if (/<!-- {docsify-ignore-all} -->/g.test(str)) {
str = str.replace('<!-- {docsify-ignore-all} -->', '');
nextToc.title = removeAtag(str);
nextToc.ignoreAllSubs = true;
}

if (/{docsify-ignore-all}/g.test(str)) {
str = str.replace('{docsify-ignore-all}', '');
nextToc.title = removeAtag(str);
nextToc.ignoreAllSubs = true;
}

const title = config.sidebar || str;
const slug = slugify(config.id || str);
const url = router.toURL(router.getCurrentPath(), { id: slug });
nextToc.title = removeAtag(title);
nextToc.slug = url;
_self.toc.push(nextToc);

return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${str}</span></a></h${level}>`;
return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${title}</span></a></h${level}>`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tried the patch, but looking at this I would think that the sidebar text would also be used in the rendered page, but I don't think this is correct. We want the sidebar text in the sidebar but not in the page.

Have you tried this? :-)

Copy link
Author

@Jacco-V Jacco-V Jun 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I have not tried the changes, because I do not have a working frontend development environment. (I'm just a backend dev giving this a try).

Copy link
Author

@Jacco-V Jacco-V Jun 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, where can I find the automated tests for this file?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

create a _sidebar.md https://docsify.js.org/#/more-pages?id=sidebar

};

origin.code = highlightCodeCompiler({ renderer });
Expand Down