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

Change the syntax of several markdown extensions #1570

Merged
merged 2 commits into from
Aug 24, 2023

Conversation

SquidDev
Copy link
Member

@SquidDev SquidDev commented Aug 23, 2023

This is an attempt to move away form some of our more complex Markdown extensions, to something which builds on top of existing markdown syntax.

  • Admonitions/alerts now use GitHub-style syntax:

    > [!NOTE]
    > Foo
    > Bar
    

    becomes

    [!NOTE]
    Foo
    Bar

  • References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print|print a string}.

Am open to changing the syntax a little bit here if people have any suggestions. Mostly creating this as a PR so the change is a little more visible.

As these are just a custom syntax on top of blockquotes, these work much
better with text editors.
@SquidDev SquidDev added enhancement An extension of a feature or a new feature. feedback wanted Tell me what you want, what you really really want. area-Documentation Improving/fixing documentation labels Aug 23, 2023
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
@SquidDev SquidDev marked this pull request as ready for review August 24, 2023 12:33
@SquidDev SquidDev merged commit 053751b into mc-1.19.x Aug 24, 2023
6 checks passed
@SquidDev SquidDev deleted the feature/new-md-syntax branch August 24, 2023 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Documentation Improving/fixing documentation enhancement An extension of a feature or a new feature. feedback wanted Tell me what you want, what you really really want.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant