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

[FEATURE] Support GitHub like Markdown Admonitions #1131

Merged
merged 2 commits into from
Oct 12, 2024
Merged

Conversation

Copy link
Member

@jaapio jaapio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With respect to backward compatibility I think we should add the AdmonitionNode in guides and make the one in RST extend from that one.

Same applies to the AdmonitionNodeRenderer that one should be moved to guides and extended in RST for BC purposes.
Otherwise guides will not work with just markdown installed.

Regarding the blockQuoteParser, I think we might need a custom extension for the commonmark library to support this properly. But that's more a nice to have. That we can revisit later.

@linawolf linawolf force-pushed the feature/md-admonitions branch from 7dbdf74 to fbdffed Compare October 11, 2024 15:59
@linawolf
Copy link
Contributor Author

I moved extended the classes in the rst. Duh, completely forgot about the node renderer

@linawolf linawolf force-pushed the feature/md-admonitions branch from fbdffed to e90abf4 Compare October 11, 2024 16:01
@linawolf linawolf requested a review from jaapio October 12, 2024 00:21
@jaapio jaapio force-pushed the feature/md-admonitions branch from e90abf4 to 17a3997 Compare October 12, 2024 11:32
@jaapio jaapio enabled auto-merge October 12, 2024 11:32
@jaapio jaapio merged commit c32f534 into main Oct 12, 2024
40 checks passed
@jaapio jaapio deleted the feature/md-admonitions branch October 12, 2024 11:36
@phpdoc-bot
Copy link

💚 All backports created successfully

Status Branch Result
1.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

phpdoc-bot added a commit that referenced this pull request Oct 12, 2024
[1.x] Merge pull request #1131 from phpDocumentor/feature/md-admonitions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support warnings in Markdown
3 participants