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

Add an extension to support GitHub alerts #845

Open
njzjz opened this issue Dec 18, 2023 · 2 comments
Open

Add an extension to support GitHub alerts #845

njzjz opened this issue Dec 18, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@njzjz
Copy link

njzjz commented Dec 18, 2023

Describe the feature you'd like to request

Last week, GitHub supported alerts as follows:

> [!NOTE]
> This is a note

Note

This is a note

See:

I hope myst-parser can add an extension to provide the same feature to provide a consistent preview for GitHub and Sphinx.

Describe the solution you'd like

Add an option to myst_enable_extensions to allow such syntax.

Describe alternatives you've considered

No response

@njzjz njzjz added the enhancement New feature or request label Dec 18, 2023
@chrisjsewell
Copy link
Member

Heya, it would probably be best if one first implemented a plugin in https://github.com/executablebooks/mdit-py-plugins

My only word of warning here, is that

  1. They have already flip-flopped on this, changing from the initial syntax they had before November 2023 > **Note** to this new one, lets hope they don't change again 😒
  2. I would agree with others in the comments for this feature; https://github.com/orgs/community/discussions/16925#discussioncomment-2794978, it basically tends to break the semantics of the blockquote syntax

Its also frustrating that Github seem to have abandoned their past spec for Github Flavoured Markdown, https://github.github.com/gfm/, when implementing these new features.

@orsinium
Copy link

+1 to the feature. While the syntax introduced by Github may suck, it is quite convenient to be able to produce documentation that is rendered in about the same way in both Github and Myst-powered web pages. Currently, the admonitions look bad on Github:

image

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

No branches or pull requests

3 participants