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.

Sign up for GitHub

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

Jump to bottom

👌 Improve admon plugin (add ??? support) #58

Merged
merged 19 commits into from
Apr 27, 2023
Merged

👌 Improve admon plugin (add ??? support) #58

merged 19 commits into from
Apr 27, 2023

Conversation

KyleKing
Copy link
Contributor

@KyleKing KyleKing commented Dec 18, 2022 •
edited
Loading

Resolves: KyleKing/mdformat-admon#9

Extend the admon plugin for the mkdocs ?-based collapsible syntax by displaying as a regular admonition

@codecov
Copy link

codecov bot commented Dec 18, 2022 •
edited
Loading

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02 🎉

Comparison is base (061a544) 92.90% compared to head (c5f278d) 92.93%.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master      #58      +/-   ##
==========================================
+ Coverage   92.90%   92.93%   +0.02%     
==========================================
  Files          30       30              
  Lines        1748     1755       +7     
==========================================
+ Hits         1624     1631       +7     
  Misses        124      124
Flag Coverage Δ
pytests 92.93% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mdit_py_plugins/admon/index.py 97.24% <100.00%> (+0.18%) ⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@KyleKing KyleKing changed the title feat: start expanded set of markers feat: minimum MkDocs Admonition Support Dec 18, 2022
@KyleKing KyleKing marked this pull request as ready for review December 18, 2022 23:04
KyleKing
KyleKing commented Dec 18, 2022
View reviewed changes
tests/fixtures/admon.md Outdated Show resolved Hide resolved
@KyleKing KyleKing mentioned this pull request Dec 18, 2022
Merged
@KyleKing
Copy link
Contributor Author

I hope you had a happy New Year!

I just wanted to follow up and see if you had any feedback on this PR, thanks!

@chrisjsewell
Copy link
Member

Heya, sorry for the delayed response 😓 if you update this to fix the conflict we can look at getting it in

@KyleKing
Copy link
Contributor Author

Thanks, resolved and ready to merge now!

@chrisjsewell chrisjsewell changed the title feat: minimum MkDocs Admonition Support 👌 Improve admon plugin (add ??? support) Feb 19, 2023
chrisjsewell
chrisjsewell requested changes Feb 19, 2023
View reviewed changes
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

See comment

mdit_py_plugins/admon/index.py Show resolved Hide resolved
chrisjsewell
chrisjsewell requested changes Feb 20, 2023
View reviewed changes
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

See comment, also could you add to the admon_plugin docstring, to note the new features, thanks

@KyleKing
Copy link
Contributor Author

See comment, also could you add to the admon_plugin docstring, to note the new features, thanks

Done! All that is left is to figure out if the HTML is parsed properly

chrisjsewell
chrisjsewell requested changes Apr 23, 2023
View reviewed changes
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

almost there thanks, see just some final "nitpick" questions

KyleKing
KyleKing commented Apr 27, 2023
View reviewed changes
Copy link
Contributor Author

@KyleKing KyleKing left a comment

Choose a reason for hiding this comment

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

Your feedback was helpful, and I'm happy to make any other changes, so let me know. Thanks again for sticking with this PR! I think this should now be ready for one last pass

tests/fixtures/admon.md Outdated Show resolved Hide resolved
tests/test_admon/test_plugin_parse_0_.yml Outdated Show resolved Hide resolved
@KyleKing KyleKing mentioned this pull request Apr 27, 2023
Merged
chrisjsewell
chrisjsewell approved these changes Apr 27, 2023
View reviewed changes
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for your patience 😄

@chrisjsewell chrisjsewell merged commit 9cb9ff9 into executablebooks:master Apr 27, 2023
9 checks passed
@KyleKing KyleKing mentioned this pull request Apr 27, 2023
Closed
@KyleKing KyleKing mentioned this pull request Jan 10, 2024
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisjsewell chrisjsewell chrisjsewell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support MkDocs "???" and "???+"
2 participants
@KyleKing @chrisjsewell