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

Document the fact that Rouge only recognises lower-case language identifiers #35697

Merged
merged 4 commits into from
Dec 20, 2024

Conversation

nisbet-hubbard
Copy link
Contributor

@nisbet-hubbard nisbet-hubbard commented Dec 18, 2024

Why:

GitHub accepts both ```Diff and ```diff for the purposes of syntax highlighting, but GitHub Pages will only highlight a ```diff code block.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Documented this caveat.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 18, 2024
Copy link
Contributor

github-actions bot commented Dec 18, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836
Copy link
Contributor

@nisbet-hubbard Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Dec 18, 2024
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

Hi @nisbet-hubbard

Thanks for raising this pull request. You learn something new every day. I hadn't realized that you could use anything other than lower-case 😄

I've suggested some changes to the wording and added a link to the supported language list for Rouge. I'd normally leave my comments open for a few days to give you an opportunity to come back to me with your thoughts on the suggestions. However, I'm going to be out of the office over the holiday period, so I'll apply my changes and merge this so the information is published without a long delay.

felicitymay
felicitymay previously approved these changes Dec 20, 2024
…rmatting/creating-and-highlighting-code-blocks.md
@felicitymay felicitymay added this pull request to the merge queue Dec 20, 2024
Merged via the queue into github:main with commit fe0b7f0 Dec 20, 2024
45 checks passed
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
get started Content related to "Getting Started" doc set pages Content related to GitHub Pages waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants