Plugin utils for documentation generation #31306
Unanswered
jooola
asked this question in
Ideas / Feature Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
I am contributing to a gatsby plugin and I've inspired myself from the
gatsby-source-wordpress
plugin, in order to generate the plugin options documentation. See https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-wordpress/generate-plugin-options-docs.jsAnd I was wondering why not export these utilities to the
gatsby-plugin-utils
to unify a way to generate a plugin documentation from the a Joi options schema declaration ?I don't know if this reduce any flexibility from the plugins options, but this should enhance many development workflow.
Maybe this utility also need to generate some typescript types, but this should be doable.
Is this a good idea ? Should I propose a PR or POC somewhere ? Any thoughts ?
Beta Was this translation helpful? Give feedback.
All reactions