-
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] Admonitions #106
Comments
We explicitly don't/won't support MYST syntax which directly influences HTML. So we never use We also explicitly don't support the open ```{note}
```
```{caution}
```
```{tip}
```
```{attention}
``` Are the supported admonitions, adding support for others is relatively straightforward if needed. |
Currently, admonitions are collapsed by default. We need to change the default behavior to be non-collapsible and open by default. |
Eek, that's a regression I introduced yesterday. Now the absence of |
Supported admonitions should be |
### Summary Per #106 (comment), supported admonition types should be `Note`, `Warning`, `Important`, and `Tip`. This list was determined after analyzing supported admonitions in our current Asciidoc system and cross-referencing with our style guide. This PR removes support for `Caution` and `Attention` and replaces them with support for `Warning` and `Important`. It also adds a missing `AdmonitionUnsupportedTest`. I've updated #3 to reflect these supported admonition types as that issue is referenced in the error logs. ### Results Tested locally with: ``` dotnet publish "src/docs-builder/docs-builder.csproj" -c Release -o .artifacts/publish \ --self-contained true /p:PublishTrimmed=true /p:PublishSingleFile=false /p:PublishAot=true -a arm64 ./.artifacts/publish/docs-builder serve ``` <img width="625" alt="Screenshot 2025-01-03 at 10 25 37 PM" src="https://github.com/user-attachments/assets/52fd3419-194f-4903-b368-724d6389e28c" /> <img width="632" alt="Screenshot 2025-01-03 at 10 25 32 PM" src="https://github.com/user-attachments/assets/7419fff1-6d4f-4177-9c8e-7a836a9591ed" />
All bugs are fixed and admonitions look good in migration script 👍 |
Summary
Some context in #3.
To do
Either map existing admonitions to new admonitions, or refine the list of supported admonitions.
Conversion output
The text was updated successfully, but these errors were encountered: