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

Update requirements #1339

Merged
merged 1 commit into from Nov 16, 2019

Conversation

@facelessuser
Copy link
Contributor

facelessuser commented Nov 16, 2019

  • Restrict Markdown to less that 3.2 to prevent CSS breakage as 3.2
    will introduce changes to how code blocks are formatted.
  • Use at least version 6.2 of Pymdown Extensions as 6.2 limits EmojiOne
    usage to v2.2.7 which has the most agreeable license for commercial
    and personal use. Additionally, limit the version to to less than 6.3
    as 6.3 will follow Python Markdown 3.2 in code block changes for
    SuperFences.
- Restrict Markdown to less that 3.2 to prevent CSS breakage as 3.2
  will introduce changes to how code blocks are formatted.
- Use at least version 6.2 of Pymdown Extensions as 6.2 limits EmojiOne
  usage to v2.2.7 which has the most agreeable license for commercial
  and personal use. Additionally, limit the version to to less than 6.3
  as 6.3 will follow Python Markdown 3.2 in code block changes for
  SuperFences.
@facelessuser

This comment has been minimized.

Copy link
Contributor Author

facelessuser commented Nov 16, 2019

At some point in the future, once Python Markdown and PyMdown Extensions release their next major version, MkDocs Material should update the code styles to support the latest code format. Once that occurs, MkDocs should also update the minimum requirements for PyMdown Extensions.

I am uncertain if PyMdown Extensions will require Markdown 3.2 in the next major release or still allow lower versions, so if the latter occurs, we'll need to update Python Markdown's minimum requirement as well. If we go the former route, you can remove the Python Markdown requirement altogether.

@squidfunk squidfunk merged commit bbba04a into squidfunk:master Nov 16, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@squidfunk

This comment has been minimized.

Copy link
Owner

squidfunk commented Nov 16, 2019

Thanks again!

At some point in the future, once Python Markdown and PyMdown Extensions release their next major version, MkDocs Material should update the code styles to support the latest code format. Once that occurs, MkDocs should also update the minimum requirements for PyMdown Extensions.

Could I ask you to open another PR once those conditions are met?

@facelessuser

This comment has been minimized.

Copy link
Contributor Author

facelessuser commented Nov 16, 2019

Yeah, I was more providing the comment as documentation, but that was my intention.

@squidfunk

This comment has been minimized.

Copy link
Owner

squidfunk commented Nov 16, 2019

Great! 4.5 with your changes will be released in a few minutes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.