-
Notifications
You must be signed in to change notification settings - Fork 1
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] Blocks #107
Comments
Reiterating from #106 but it bares repeating IMO 😸
So we'll never want to expose new features by adding a 'class' as per:
In the case of Adding the
Or we support a more general dropdown region with the
I would caution against this. Make 3 backticks the default only use If this comes up a lot I suspect it might be hiding a new directives use case. |
Thanks. Added to list of things to fix in migration tooling. |
Fixed in tooling. |
Summary
A block admonition is converted to MyST admonition block directive. If the admonition has a title, then the {admonition} directive is used. The type of the admonition is passed as the class attribute.
admonition_type: NOTE | TIP | IMPORTANT | CAUTION | WARNING
Other classes can also be added to the class attribute. For example, if [%collapsible] option is specified for the admonition block, then “dropdown” will also be added to the class attribute
If the admonition doesn’t have a title, then the following syntax will be used
In both cases above, note that we are using 4 backquotes instead of 3. That’s because an admonition can have other directives nested in it. So it needs to have more than 3 backquotes. The minimum required number depends on the levels of nesting. Dynamically assigning the backquotes depending on their nested directives, is currently out of the scope of this project.
To do
Determine if we will support
[%collapsible]
.Related
#106
The text was updated successfully, but these errors were encountered: