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

Anchor (jump) links broken in documentation #1745

Closed
paddor opened this issue Dec 29, 2023 · 4 comments
Closed

Anchor (jump) links broken in documentation #1745

paddor opened this issue Dec 29, 2023 · 4 comments
Labels

Comments

@paddor
Copy link
Contributor

paddor commented Dec 29, 2023

Low priority, but I noticed that anchor links are missing the #anchor part. For example on [1], the link in line "Raw mode sockets ignore all these restrictions." does not include the #raw_mode part, even though the source [2] mentions it.

[1] https://nng.nanomsg.org/man/tip/nng_rep.7.html
[2] https://github.com/nanomsg/nng/blob/master/docs/man/nng_rep.7.adoc?plain=1#L53

@paddor paddor changed the title Anchor (jump) links broken Anchor (jump) links broken in documentation Dec 29, 2023
@gdamore
Copy link
Contributor

gdamore commented Dec 30, 2023

This is indeed correct. I think the problem is that tool I use to create the website is dropping the anchors. I'll have to look.

@gdamore
Copy link
Contributor

gdamore commented Dec 30, 2023

Yeah, it's not my tool, but probably the Go libasciidoc package that is getting this wrong.

@gdamore
Copy link
Contributor

gdamore commented Jan 2, 2024

I filed bytesparadise/libasciidoc#1112 to track this with libasciidoc.

@gdamore gdamore added the docs label Feb 3, 2024
@gdamore
Copy link
Contributor

gdamore commented Feb 24, 2024

There were other problems -- libasciidoc was failing to handle index links (not just ignore them, but emitting even hidden index terms in the formatted document.)

I've fixed this by switching back to regular asciidoctor.

Unfortunately it seems that libasciidoc is just not quite ready for the most demanding use cases, and the NNG docs are fairly demanding.

Anyway its fixed now.

@gdamore gdamore closed this as completed Feb 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants