react-styleguidist

Include markdown file in style guide without associated component file?

Is there a way to include markdown files in styleguidist that don't have an associated React component file?

Right now I'm using dummy components to accomplish this but I'm wondering if there is a better way? I'm also hiding the dummy component's path (via getComponentPathLine() in the config) so that it doesn't appear like a component in the style guide.

Thanks

Solution

  • In your style guide config:

    module.exports = {
  sections: [
    {
      name: 'Introduction',
      content: 'docs/introduction.md'
    }
  ]
}

    See more examples in the docs.