Add support for callout syntax (#1875)#1879
Add support for callout syntax (#1875)#1879leandrobbraga wants to merge 1 commit intoastral-sh:mainfrom
Conversation
leandrobbraga
force-pushed
the
mkdocs-callout
branch
from
f30448f to
631fe6d
Compare
leandrobbraga
force-pushed
the
mkdocs-callout
branch
from
631fe6d to
8f54e34
Compare
leandrobbraga
changed the title
leandrobbraga
force-pushed
the
mkdocs-callout
branch
from
8f54e34 to
7d23695
Compare
|
Thank you. Do you know how this plugin is different from mkdocs-github-admonitions-plugin which we use in ruff |
|
My understanding is that they serve similar purposes: mkdocs-callout converts from Obsidian’s format, and mkdocs-github-admonitions-plugin converts from GitHub’s format. The issue is that the syntax used is I believe the better solution is to use the admonitions format directly: Some examples:
!!! note "Added in Ruff `0.9.8`"
The **Inline JSON configuration** option was introduced in Ruff `0.9.8`.I’ve opened this alternative solution at astral-sh/ruff#21961. |
3 participants
This resolves the issue of Markdown callouts not rendering in MkDocs.
I used https://github.com/sondregronas/mkdocs-callouts, which is compatible with the syntax already being used in this specific part of the documentation.
Before
After
Alternative Solution
An alternative solution would be to not add a new dependency and change the callout syntax in the original code. This was implemented in astral-sh/ruff#21961.
!!! warning "Deprecated" This option has been deprecated. Use `environment.root` instead.Closes #1875