How to create a reference for an admonition

[andrewnicols]

I'm trying to find a way to create a bookmark link for an admonition so that I can essentially provide more detail for terminology, however the {#my-explicit-id} syntax documented at https://docusaurus.io/docs/markdown-features/headings#explicit-ids seems only be for headings.

Given the admonition does include a header, should it not also be possible to link to it?

[slorber]

I don't understand sorry. Do you have any example in the wild (on any doc site) using a setup similar to what you are trying to do?

Given the admonition does include a header, should it not also be possible to link to it?

I'm not sure headers in admonitions is a good doc / HTML practice, but it should work and you should be able to link to any heading (unless you put them in collapsible/hideable items like details or tabs)

[homotechsual]

Is the goal to have a syntax like this?

:::info Keyword {#keyword}
some text
:::

This would be ace.

[yasutakeyohei]

I've written a blog post on how to achieve this with swizzling, remark, and rehype. Hope you find it useful.

The syntax is like:

:::info ### title_here

some text

:::

https://yasutakeyohei.com/docs/blog/2024/01/27/docusaurus-admonition-heading-toc/

[levino]

Is this still not possible without heavy lifting?

[slorber]

This issue is old and we haven't implemeted anything

Note that with MDX, you can use JSX in admonitions so it's technically possible to add anchors anywhere

:::note

<a id="my-linking-id" />

My text

:::

[levino]

It kinda works but I think in such cases, there is no offset being calculated and the content is hidden (partially at least) behind the navbar. I added a heading before the admonition and scrolling to that works much better.