Skip to content

Document yaml as supported language for syntax highlighting #1270

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mportiz08
Copy link
Contributor

Bug/issue #, if applicable:

Summary

Document that yaml code listings can now be syntax highlighted with DocC-Render.

Adds an entry to the table in the "Add Code Listings" section of the "Formatting your documentation content" article that documents which languages are expected to have syntax highlighting support in the renderer.

Dependencies

swiftlang/swift-docc-render#960 (thanks @heckj!)

Testing

Steps:

  1. Run bin/preview-docs DocC and verify that the new table entry can be found at http://localhost:8080/documentation/docc/formatting-your-documentation-content#Add-Code-Listings

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@mportiz08 mportiz08 requested a review from franklinsch August 4, 2025 21:33
@heckj
Copy link
Member

heckj commented Aug 4, 2025

@swift-ci please test

Copy link
Member

@heckj heckj left a comment

Choose a reason for hiding this comment

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

Thank you @mportiz08 ! Definitely great to have that update in here!

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