Arbitrary anchor in Documenter

General Usage
,
1

The Documenter docs show how it’s possible to explicitly name a header with something like

# [Header](@id my_custom_header_name)

which can then be linked to in the documentation with something like

[Custom Header](@ref my_custom_header_name)

I’d like to be able to do the same for an arbitrary point on the page — not just a header. Is this possible?

I’ve tried just using the same syntax outside of a header, but it errors with “invalid local link/image: file does not exist in [the file where I placed it]”.

I can add it as raw HTML like this:

```@raw html
<a id="L_operators_Euler_angles"></a>
```

It’s ugly, but it works — in the sense that I can manually enter that id in the URL and it jumps to the right spot. The problem is that then I don’t know how to actually link to it because

  1. inline raw HTML is not allowed, so any link to it has to be in its own paragraph, and
  2. Documenter doesn’t recognize the raw anchor, so I can’t just use @ref with it.

Is there anything I can do that doesn’t involve just writing my docs in HTML?

2

This has been discussed in Documenter#745 and Julia#2584. People seem to agree that it’s a good idea, but nobody has done anything about it.

3

I just did something about it.