-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor: expose gatsby-transformer-raml options #271
Conversation
This pull request is being automatically deployed with ZEIT Now (learn more). 🔍 Inspect: https://zeit.co/commercetools/commercetools-docs-kit/czf7i7web |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a code perspective this looks fine to me, can't say too much about the logic though
@@ -12,7 +12,7 @@ module.exports = (themeOptions = {}) => ({ | |||
'@commercetools-docs/gatsby-transformer-mdx-introspection', | |||
{ | |||
resolve: '@commercetools-docs/gatsby-transformer-raml', | |||
options: {}, | |||
options: { ...themeOptions.transformerRaml }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
options: { ...themeOptions.transformerRaml }, | |
options: themeOptions.transformerRaml, |
@@ -53,6 +53,52 @@ module.exports = { | |||
}; | |||
``` | |||
|
|||
### API Specs Directory Structure | |||
|
|||
One of the benefits of the gatsby-transformer-raml tool is that it supports multiple api specs parsing. For this to work properly, we recommend setting up the the specs root directory such that all the specs directory are flattened. See example below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of the benefits of the gatsby-transformer-raml tool is that it supports multiple api specs parsing. For this to work properly, we recommend setting up the the specs root directory such that all the specs directory are flattened. See example below: | |
One of the benefits of the gatsby-transformer-raml tool is that it supports multiple api specs parsing. For this to work properly, we recommend setting up the specs root directory such that all the specs directory are flattened. See example below: |
loadNodeContent, | ||
reporter, | ||
}, | ||
{ includeApis = [], movePropertiesToTop = [], movePropertiesToBottom = [] } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
{ includeApis = [], movePropertiesToTop = [], movePropertiesToBottom = [] } | |
{ includeApis = [], movePropertiesToTop = [], movePropertiesToBottom = [] } = {} |
Closes #230