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

Support for Admonition Syntax #1370

Open
ZhiyuanChen opened this issue Aug 9, 2024 · 2 comments
Open

Support for Admonition Syntax #1370

ZhiyuanChen opened this issue Aug 9, 2024 · 2 comments

Comments

@ZhiyuanChen
Copy link

Is your feature request related to a problem? Please describe.

The Admonition extension adds rST-style admonitions to Markdown documents.

This extension is included in the standard Markdown library, and has been widely in used in other repositories such as MkDocs

Supporting admonition syntax would let users highlight important stuff, like license (agreement), etc.

Describe the solution you'd like

Add support for admonition syntax.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Nill

Additional context
Add any other context or screenshots about the feature request here.

image
@julien-c
Copy link
Member

i think we support GitHub-style notes

This syntax: https://github.com/orgs/community/discussions/16925

cc @mishig25

@ZhiyuanChen
Copy link
Author

i think we support GitHub-style notes

This syntax: https://github.com/orgs/community/discussions/16925

I looked into the syntax, and it's really nice.

However, as I'm trying to write one md for both model card and in documentation, while it's possible for me to extend mkdocs, it is still less convenience.

Also, the GitHub-style notes lacks capabilities for i18n.

!!! Warning "警告"

I could use this syntax customise the name of the notes, but not in GitHub syntax.

I think adding support for admonition can still be a welcome addition, but not a mandatory one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants