Skip to content

Updated images documentation to include pymdownx.blocks.caption exten… #7654

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

Merged
merged 3 commits into from
Oct 30, 2024
Merged

Updated images documentation to include pymdownx.blocks.caption exten… #7654

merged 3 commits into from
Oct 30, 2024

Conversation

joapuiib
Copy link
Contributor

Updates Image Reference Page to include captions with pymdownx.blocks.caption extension.

Discussion in #4974

I had a doubt when setting the minimum version in configuration guide.

Would this version be the minimum version of pymdownx or mkdocs-material?

+<!-- md:version 1.0.0 -->

@squidfunk
Copy link
Owner

Would this version be the minimum version of pymdownx or mkdocs-material?

Material for MkDocs. You can use 1.0.0, since the extension is not exclusive to Material for MkDocs.

Also, please do not delete the part where we say that Markdown does not support figures – I'm still not the biggest fan of the blocks syntax for the noise it adds, so please add this as an additional way of using figures.

The text can be adjusted in a way that it offers two options, the first being the HTML part, because the PymdownX extension is very new. In those cases, we always aim to be a little more defensive on our docs, since the moment it's mentioned on our docs, people will ask us for free support here on the discussion board.

@joapuiib
Copy link
Contributor Author

I've kept the original text and added an alternative syntax below.

@joapuiib joapuiib marked this pull request as ready for review October 30, 2024 13:35
@squidfunk
Copy link
Owner

Perfect, LGTM! Thanks for taking the time!

@squidfunk squidfunk merged commit f82a345 into squidfunk:master Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants