Section content option path is relative to the project root (and should be relative to config file location)

[mik01aj]

From README:

• sections
  
  Type: Array

  Allows components to be grouped into sections with a title and optional overview content. Sections can also be content only, with no associated components (for example, a textual introduction). A section definition consists of:
  

  • name - the title of the section.
  • content (optional) - location of a Markdown file containing the overview content.
  • components (optional) - a string or function providing a list of components. The same rules apply as for the root components option.

  Configuring a guide with a textual introduction section, then a UI section would look like:

  module.exports = {
    // ...
    sections: [
      {name: 'Introduction', content: 'docs/introduction.md'},
      {name: 'UI Components', content: 'docs/ui.md', components: 'lib/components/ui/*.js'}
    ]
  }

The 2 path options (content and components) handle path inconsistently. With components (as well as other config options, e.g. styleguideDir) the path is relative to the config file. The content path is relative to the webpack context (project root in this case). Often it means the same, but not when the config is not in the project root.

Related source line: https://github.com/sapegin/react-styleguidist/blob/a12accff15e8f42fc779f8e9faa277fbea4bc0d3/loaders/styleguide.loader.js#L62

CC @paulj

[mik01aj]

Maybe doing path.resolve(section.content) would be enough?

[mik01aj]

thanks!