Task #80403
closed
Use highlight:: yaml in .rst when describing a yaml configuration
100%
Description
In the current core there are many .rst files where the style 'code-block::typoscript' is used
to describe a yaml configuration.
Actually one should use 'highlight:: yaml', because the syntax-highlighter 'pygments' can recognize yaml
Updated by Martin Bless about 7 years ago
This is a valid matter of concern and the core manuals should be updated by the documentation writers accordingly. Note that in the meantime there is a new manual "Writing Documentation" which is the perfect place to hold such knowledge:
https://docs.typo3.org/typo3cms/HowToDocument/WritingReST/Codeblocks/Index.html#syntax-highlighting
It is WIP, Work In Progress and in a very early state. Feel free to add to the new manual.
Updated by Frank Nägler about 7 years ago
- Status changed from New to In Progress
- Assignee set to Frank Nägler
Updated by Gerrit Code Review about 7 years ago
- Status changed from In Progress to Under Review
Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/52234
Updated by Frank Nägler about 7 years ago
- Status changed from Under Review to Resolved
- % Done changed from 0 to 100
Applied in changeset 4743b9254131fbd3d29b58a2248e7d975f02e144.
Updated by Riccardo De Contardi over 6 years ago
- Status changed from Resolved to Closed