Skip to content

Addon-docs: Add preset options for vue-docgen-api #9699

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.

Sign up for GitHub

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

Jump to bottom
Merged
shilman merged 1 commit into from
Feb 8, 2020
Merged

Addon-docs: Add preset options for vue-docgen-api #9699

shilman merged 1 commit into from
Feb 8, 2020

Conversation

@pocka
Copy link
Contributor

@pocka pocka commented Feb 1, 2020

Issue: close #9615 , close #9695

What I did

Added vueDocgenOptions to the addon-docs' preset option.

// main.js
module.exports = {
  addons: [
    {
      name: '@storybook/addon-docs',
      options: {
        vueDocgenOptions: {/* options for vue-docgen-api */}
      }
  ]
}

How to test

  • Is this testable with Jest or Chromatic screenshots? ... no
  • Does this need a new example in the kitchen sink apps? ... no
  • Does this need an update to the documentation? ... yes

If your answer is yes to any of these, please make sure to include it in your PR. ... updated addons/docs/vue/README.md

@pocka
feat(addon-docs): Preset options for vue-docgen-api
e5a9e30 
This commit adds a `vueDocgenOptions` option to the preset options.
It enable users to configure vue-docgen-api for the purpose such as
setting aliases or ignore certain named-exports.

#9615
@shilman shilman changed the title Preset options for vue-docgen-api Addon-docs: Add preset options for vue-docgen-api Feb 8, 2020
shilman
shilman approved these changes Feb 8, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @pocka ! 💯

@shilman shilman added this to the 6.0.0 milestone Feb 8, 2020
@shilman shilman merged commit 9e5a0ed into storybookjs:next Feb 8, 2020
@pocka pocka deleted the feature/docs-vue-docgen-options branch February 8, 2020 14:22
This was referenced Feb 8, 2020
Closed
Closed
@Dschungelabenteuer Dschungelabenteuer mentioned this pull request Mar 13, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shilman shilman shilman approved these changes

Assignees

No one assigned

Labels

addon: docs feature request

Projects

None yet

Milestone

6.0

Development

Successfully merging this pull request may close these issues.

Docs does not render Vue Mixin Properties Addon-docs: Options for vue-docgen-api

2 participants

@pocka @shilman