Document yaml as supported language for syntax highlighting #1270
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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-ListingsChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded