Closed rmiyashiro closed 7 years ago
🍥
Is the suggestion that defaultFlavorOptions
be a field on Service? I am down with that but would prefer a different name like defaultDocgenOptions
Yes, a field on Service. Definitely looking for a better name for the field. defaultDocgenOptions
is fine with me.
Ok let's go with that. Feel free to update field name and accept the PR
But then add a ticket to carbond Issues for this to be documented.
This change adds the ability to configure flavor-specific defaults for the options that can be passed to gen-static-docs. For example, if you want Aglio-flavored documentation for your service to be full width by default, you'd add this to your service:
This is most useful if you've created custom themes and styles that are optimized for your service's documentation. For example:
With this in place, users can simply run gen-static-docs with no options and your custom styles will be used. For example:
Instead of: