You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Making this PR against core-rewrite for cleaner diffs, but it should target v8 once #2858 is merged.
We can have mkdocs auto-generate plugin parameter tables to reduce some redundancy, prevent mismatches, and – by moving extended parameter descriptions into source files – improve in-editor code hints 🎉
This setup uses the mkdocs-macros plugin and TypeDoc under the hood: When writing {{ plugin_parameters('html-keyboard-response') }} in a plugin's documentation, mkdocs invokes a python function that uses TypeDoc to parse the plugin's index.ts, retrieving a JSON representation which it uses to generate and return the markdown table ✨
To try it, check out the PR, run npm install, poetry install and npm run docs:preview. The html-keyboard-response.md docs look the same, but were generated on-the-fly 👍 Editing packages/plugin-html-keyboard-response/src/index.ts rebuilds the documentation.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Oh that's fantastic. I've been dreaming of something like this for a while and never had the time to figure out how to pull it off. Excited to try it out and make the switch.
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.
Making this PR against
core-rewritefor cleaner diffs, but it should targetv8once #2858 is merged.We can have mkdocs auto-generate plugin parameter tables to reduce some redundancy, prevent mismatches, and – by moving extended parameter descriptions into source files – improve in-editor code hints 🎉
This setup uses the
mkdocs-macrosplugin and TypeDoc under the hood: When writing{{ plugin_parameters('html-keyboard-response') }}in a plugin's documentation, mkdocs invokes a python function that uses TypeDoc to parse the plugin'sindex.ts, retrieving a JSON representation which it uses to generate and return the markdown table ✨To try it, check out the PR, run
npm install,poetry installandnpm run docs:preview. Thehtml-keyboard-response.mddocs look the same, but were generated on-the-fly 👍 Editingpackages/plugin-html-keyboard-response/src/index.tsrebuilds the documentation.