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

[Discuss] Inline admonitions #108

Open
bmorelli25 opened this issue Dec 17, 2024 · 3 comments
Open

[Discuss] Inline admonitions #108

bmorelli25 opened this issue Dec 17, 2024 · 3 comments
Labels
authoring Relates to our markdown parser question Further information is requested

Comments

@bmorelli25
Copy link
Member

Summary

You can find an example of an inline admonition in this page:

Data set quality | Elastic Observability [8.17] | Elastic

The text [beta] on top of the page is an inline admonition. If you have over it, you will see a tooltip-style box. There is no equivalent functionality in MyST, so for now we are converting it an admonition of type ‘important'.

```{admonition} <title>
:class: important
<text>
```

To do

@bmorelli25 bmorelli25 added the authoring Relates to our markdown parser label Dec 17, 2024
@Mpdreamz
Copy link
Member

I don't think we should support this for reasons mentioned here: #94 (comment)

@bmorelli25
Copy link
Member Author

This decision to be validated during migration. Added as an open question to #160.

@bmorelli25
Copy link
Member Author

From @siamakp-elastic in regards to inline admonitions in code callouts:

Look at this page:
https://www.elastic.co/guide/en/observability/current/apm-open-telemetry-direct.html
The callout #8 has an inline admonition preview. I used to render them ('beta', 'preview', etc) as block admonitions. But admonition won't work in the callout case above. I've changed it to be just the title in the brackets: [preview].
That means that the documents that have an inline beta inline admonition, will just show [beta] without any more information. Note that the Asciidoc inline admonition acts like a hover tooltip.

@bmorelli25 bmorelli25 changed the title [Migration tooling] Inline admonition [Discuss] Inline admonitions Jan 13, 2025
@bmorelli25 bmorelli25 added the question Further information is requested label Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authoring Relates to our markdown parser question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants