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

Add syntax highlight for additional coding languages #657

Merged

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Jan 17, 2025

Description

This PR adds syntax highlighting for additional coding languages.

Note

  • By default, Docusaurus includes a limited number of languages that have syntax highlighting, as described in their documentation.
  • When testing syntax-highlighting feature, I tried to apply shell-session, which shows as being the common language/syntax supported in Prism and in Docusaurus after the site is built (in node_modules/prismjs/components/prism-shell-session.js), but I didn't see any changes, visually, to the code blocks.

Related issues and/or PRs

N/A

Changes made

  • Added the following languages to the Docusaurus configuration file, which enables syntax highlighting:
    • csharp
    • docker
    • gradle
    • java
    • json
    • log
    • properties
    • python
    • scala
    • shell-session
    • sql
    • toml

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

@josh-wong josh-wong added the enhancement New feature or request label Jan 17, 2025
@josh-wong josh-wong self-assigned this Jan 17, 2025
@josh-wong josh-wong force-pushed the docusaurus/add-syntax-highlighting-for-additional-languages branch from 6445d12 to 80f3a44 Compare January 21, 2025 02:35
@josh-wong josh-wong marked this pull request as ready for review January 21, 2025 04:34
@josh-wong josh-wong merged commit a076c43 into main Jan 21, 2025
1 check passed
@josh-wong josh-wong deleted the docusaurus/add-syntax-highlighting-for-additional-languages branch January 21, 2025 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant