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 HTML syntax to Markdown for images (3.9) #879

Merged
merged 1 commit into from
May 16, 2023

Conversation

josh-wong
Copy link
Member

This PR changes how images are inserted into documentation.

Previously, the docs used HTML syntax to add images. However, Jekyll, the static site generator that our docs site is based on, cannot render those images because we have permalink: pretty enabled in the site configuration.

Note

permalink: pretty makes URLs a bit easier to read. For more information, see Built-in formats | Permalinks and Permalinks | Jekyll Style Guide.

Markdown syntax supports adding images, so I've updated the docs for branch 3.9, which is under support, to follow that standard.

Copy link
Collaborator

@brfrn169 brfrn169 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Contributor

@komamitsu komamitsu left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@Torch3333 Torch3333 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@brfrn169 brfrn169 merged commit c76c9f0 into 3.9 May 16, 2023
12 checks passed
@brfrn169 brfrn169 deleted the docs/3.9/change-html-to-markdown branch May 16, 2023 05:15
@brfrn169 brfrn169 restored the docs/3.9/change-html-to-markdown branch May 16, 2023 05:16
@brfrn169 brfrn169 deleted the docs/3.9/change-html-to-markdown branch May 16, 2023 05:16
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.

None yet

4 participants