chore: automate plugin page headings #8
Merged
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.
Makes two major changes to our documentation.
Now we check the front matter, and determine if we're currently rendering a plugin page and inserts the PluginUsage, PluginParams, and PluginDemo components.
We specified these components in the docs pages themselves before, because Docusaurus won't generate TOC entries from headings in React components. However, we hack around this by inserting them in the TOC component itself if it's a plugin page.
It's a little hacky, but makes the documentation much cleaner and reduces human-error, which has already caused issues in the documentation before.
The other change is that this drops the implementation heading for each plugin, and instead inserts an entry before to the "Edit this page on GitHub" link to "Read the implementation". This is much cleaner.