conjure icon indicating copy to clipboard operation
conjure copied to clipboard

Referencing Links in Table Of Content

Open nickbar01234 opened this issue 11 months ago • 0 comments

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.

nickbar01234 avatar Aug 31 '23 11:08 nickbar01234