docs: add support for $metadata plugin metadata#5517
Merged
Conversation
Member
Author
This allows plugins to optionally define which stream metadata variables are available, with an optional comment for each variable. `$metadata` can be repeated multiple times, once for each supported variable, and it must be set immediately after the mandatory `$type`. The supported variables must be defined in the following order: - id - author - category - title The optional comment is separated by a simple space character, but it is rendered differently in the docs.
6cd334c to
36c305f
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This allows plugins to optionally define which stream metadata variables
are available, with an optional comment for each variable.
$metadatacan be repeated multiple times, once for each supportedvariable, and it must be set immediately after the mandatory
$type.The supported variables must be defined in the following order:
The optional comment is separated by a simple space character, but it
is rendered differently in the docs.
Resolves #5516
The plugin metadata changes are all based on this simple regex
self\.(id|author|category|title), so this data might be wrong and/or incomplete, and optional comments are missing too.The rendering of the plugins page could be improved later on. I couldn't figure out how to style
:refs:in rst and my MyST-parser custom syntax attempts failed.