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

[Migration tooling] Example blocks & Sidebars #110

Closed
bmorelli25 opened this issue Dec 17, 2024 · 2 comments
Closed

[Migration tooling] Example blocks & Sidebars #110

bmorelli25 opened this issue Dec 17, 2024 · 2 comments
Labels
authoring Relates to our markdown parser

Comments

@bmorelli25
Copy link
Member

bmorelli25 commented Dec 17, 2024

Example blocks

Example blocks are treated like admonitions in migration tooling.

Sidebars

Sidebars are rendered as admonitions.

@bmorelli25 bmorelli25 added the authoring Relates to our markdown parser label Dec 17, 2024
@bmorelli25 bmorelli25 changed the title [Migration tooling] Example blocks [Migration tooling] Example blocks & Sidebars Dec 17, 2024
@Mpdreamz
Copy link
Member

Sidebars: See also #4

We did support this for a while to shift/float content to the right. See also https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside for more information on <aside> html tag.

I don't think we need it today as discussed on #4

Example blogs:

Do we have examples for these in the our documentation? What are they generally used for?

Sorta related are the #30 and #31 directives which are hyper specialized boxes we opted not to support from Myst (for now).

I wonder if these are really always genuine admonitions.

@bmorelli25
Copy link
Member Author

bmorelli25 commented Jan 10, 2025

I wonder if these are really always genuine admonitions.

I think you nailed it with this statement.

Migration tooling converts all examples (here's an example of an example block for you (step4)) to TIP admonitions. From there, writers will have to figure out if that's the correct admonition type to use or if an admonition isn't needed at all.

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
Projects
None yet
Development

No branches or pull requests

2 participants