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.

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

Referencing Links in Table Of Content #1444

Open
nickbar01234 opened this issue Aug 31, 2023 · 0 comments
Open

Referencing Links in Table Of Content #1444

nickbar01234 opened this issue Aug 31, 2023 · 0 comments

Comments

@nickbar01234
Copy link
Contributor

nickbar01234 commented Aug 31, 2023

What happened?

Anchor tags to reference subsections in the wire specification do not work. When I click on the table of content, say 1. Conventions, the url becomes #/docs/spec/wire?id=1-conventions. The expected url should have _ prepended, #/docs/spec/wire?id=_1-conventions - this can be verified by selecting 1. Conventions from the sidebar.

After some digging, I came across this issue on docsify. When generating the website, docsify added the _ for selectors that start with digits.

What did you want to happen?

Prepending _ for any sections in the table of content that start with a digit will make the link work as expected.

[1. Conventions](#1-conventions)
<!-- becomes -->
[1. Conventions](#_1-conventions)

My only concern is that I'm not sure if this would break the expected behavior when markdown-toc is used to generate the table of content. It's not immediately clear to me why markdown-toc was required from reading its official doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant