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

web docs: headings differing in case (eg: tags and Tags) are not linked properly in TOC/search #1534

Closed
jblachly opened this issue Apr 20, 2021 · 3 comments
Labels
A-BUG Something wrong, confusing or sub-standard in the software, docs, or user experience. docs Documentation-related.

Comments

@jblachly
Copy link

The #tags anchor is used twice; once in the CLI section:

https://hledger.org/hledger.html#tags

And once for the Journal format section. Both are linked from the TOC. However, the hyperlink to journal format section does not work for obvious reasons.

I attempted to fix this myself for PR but am slightly embarrassed to say that the documentation file structure and mechanics are too convoluted for me.

@jblachly jblachly added the A-BUG Something wrong, confusing or sub-standard in the software, docs, or user experience. label Apr 20, 2021
@jblachly
Copy link
Author

Update: the anchor in the actual journal format documentation is #tags-1, however, the TOC still links to #tags

@simonmichael simonmichael added the docs Documentation-related. label Apr 20, 2021
@simonmichael
Copy link
Owner

simonmichael commented Apr 20, 2021

Thanks! This is in progress at badboy/mdbook-toc#15 and badboy/mdbook-toc#16.

[See also https://github.com/simonmichael/hledger_site/issues/33.]

@simonmichael simonmichael changed the title Documentation: anchor #tags is used twice: CLI and Journal format web docs: headings differing in case (eg: tags and Tags) are not linked properly in TOC/search Apr 21, 2021
@simonmichael
Copy link
Owner

simonmichael commented Jun 15, 2021

Closing this in favour of simonmichael/hledger_site#33, reducing the issue count from 6 to 5. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-BUG Something wrong, confusing or sub-standard in the software, docs, or user experience. docs Documentation-related.
Projects
None yet
Development

No branches or pull requests

2 participants