Docsify: Sidebar level link does not work if header starts with numbers

[StanleyWei]

Bug Report

Thanks for this great app and I just got one issue for now, if the header text in the document starts with numbers, the auto links in the sidebar will not work. For example:

Header text in the document as follows:

1. Introduction
   1.1 Purpose

The auto links will be resolved as like http://localhost:3000/#/mybook?id=1-introduction, it will not redirect to the right section when this link was clicked.

If I add any other characters before that, e.g. Chapter 1 Introduction, then it works very well.

I am wondering whether it could support this kind of scenario, or it does support and I may miss something in configuration, please advise. Thanks very much!

Steps to reproduce

• Change the header text with number started
• Enable sidebar and ensure the maxlevels include the corresponding header texts
• Click the sidebar level link

What is current behaviour

• Sidebar level link does not work if header text starts with numbers, like 1. Overview

What is the expected behaviour

• Enable auto links of header text to support leading numbers.

Other relevant information

• [X] Bug does still occur when all/other plugins are disabled?

• Your OS: Windows WSL
• Node.js version: v10.16.3
• npm/yarn version: 6.14.3
• Browser version: Firefox 74.0
• Docsify version: docsify-cli 4.4.0
• Docsify plugins: default

[anikethsaha]

can you share a reproducible sandbox for this . we have a demo sandbox in the readme.
Also, is it working on docsify version 4.10.2 ?

[StanleyWei]

You may try the test link below: https://data42.cn/docsify/docs/#/?id=introduction
You will see if click the menu 01: balabala, it will not work. Thanks very much!

Regards,
Stanley

[Koooooo-7]

hey, it seems the bug about the element id start with numbers, if u want resolve it right now, u can add ur customer header ids , reference this Customise ID for headings.

@anikethsaha How about add a common id prefix by default to avoid those issues?
it looks like

<h3 id="docsify-xxxxxxx">

[anikethsaha]

@anikethsaha How about add a common id prefix by default to avoid those issues?
it looks like

@Koooooo-7 this is a good solution but then we need to change the ids of the source as well like the markdown rendering as content.
or,
removing the prefix by listening to onclicks, might make it slow

I am pretty sure it was working before but don't know the exact version

[Koooooo-7]

@Koooooo-7 this is a good solution but then we need to change the ids of the source as well like the markdown rendering as content.or,removing the prefix by listening to onclicks, might make it slow

I mean I just add the prefix on the origin.heading = renderer.heading function .

// it will only work on the titles.
const slug = "docsify-"+slugify(config.id || str);
const url = router.toURL(router.getCurrentPath(), { id: slug });
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}>`;

---

I am pretty sure it was working before but don't know the exact version

I get it, in the old version( ~v4.10.2), it will replace the front digit to _$1 in slugify.js.

  let slug = str
    .trim()
    .replace(/[A-Z]+/g, lower)
    .replace(/<[^>\d]+>/g, '')
    .replace(re, '')
    .replace(/\s/g, '-')
    .replace(/-+/g, '-')
    .replace(/^(\d)/, '_$1')
  let count = cache[slug]

But this merge removed it, Fix #895 (#896) in v4.11.0.

  let slug = str
    .trim()
    .replace(/[A-Z]+/g, lower)
    .replace(/<[^>\d]+>/g, '')
    .replace(re, '')
    .replace(/\s/g, '-')
    .replace(/-+/g, '-');
  let count = cache[slug];

[anikethsaha]

Please try new version 4.11.3 to check if it still exists.

@Koooooo-7 can you check this and see if we can merge these two cases. Else can you create a separate issue. We can surely discuss about it, it looks good to have

[Koooooo-7]

Please try new version 4.11.3 to check if it still exists.

the latest v4.11.2 is still exist this problem.

@Koooooo-7 can you check this and see if we can merge these two cases. Else can you create a separate issue. We can surely discuss about it, it looks good to have

I opened a new one #1093 , and I may miss some relative issues, u could add them in.

[anikethsaha]

the latest v4.11.2 is still exist this problem.

you meant v4.11.3 ?

[Koooooo-7]

the latest v4.11.2 is still exist this problem.

you meant v4.11.3 ?

I didn't find the v4.11.3 tag to checkout. so I test the latest v4.11.2 only.

[anikethsaha]

i released that yesterday.

[Koooooo-7]

the latest v4.11.2 is still exist this problem.

you meant v4.11.3 ?

I didn't find the v4.11.3 tag to checkout. so I test the latest v4.11.2 only.

i released that yesterday.

……okay, maybe I missed something.:cat: could u test the v4.11.3 . If the slugify.js hasn't been updated, I guess the issue is still exist.

[anikethsaha]

it has been changed in slugify.js . check https://github.com/docsifyjs/docsify/commit/154abf59a6153e84b018fcdffa86892776d6da7d

[Koooooo-7]

it has been changed in slugify.js . check 154abf5

sounds good. :+1:
BTW: I still can't checkout this tag and I didn't find it at the release and repo right now... idk.

[anikethsaha]

~Yea, I think the publish script didn't work as expected. IDK why. I will check that~

I ran yarn publish instead of yarn pub 😅

[Koooooo-7]

:joy: that's okay. and I tested on the v4.11.3, it works. :100:

[StanleyWei]

Thank you both very much, @Koooooo-7 @anikethsaha, just tried the latest version and it works well. I will close this issue.

Regards,
Stanley