feat: generate yaml code blocks from json config examples #65
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
6 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes:
Adds a simple postprocessor to create a tabbed json/yaml codeblock if the code in existing example blocks is valid JSON, log a warning otherwise.
The logging, yaml indent/flow and other things can still be tweaked of course, just a demo for renovatebot/renovate#7031.
I did have to bump the mkdocs stack to make sure the configuration was picked up correctly, so this may need a manual check that everything is OK, but seems fine to me so far.
Context:
For discussion in renovatebot/renovate#7031. Depends on that feature first of course.