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)

[Josh-Cena]

@slorber The admonition compiles to an h5 heading. Complained here: elviswolcott/remark-admonitions#26 But because it doesn't have an id, it's not actually an anchor.

[andrewnicols]

Sorry, I don't currently have an example but I'll try and find one tomorrow.

I want to be able to provide an anchor on an admonition to allow cross-referencing to it within the doc.

Since there is no jargon or terminology plugin for Docusaurs, we're currently looking at using an info admonition to describe more information about a key word, and then linking to that keyword, but right now we can't actually link to the admonition.

[slorber]

Using a headng in an admonition seems to work and produce an anchor

(but no TOC entry)

Is the goal to have a syntax like this?

:::info Keyword {#keyword}

some text

:::

[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/