Support docs & components from source directory & dependencies

[axe312ger]

Situation

I am working on a set of components which can be easily reused over several Gatsby projects. Additionally I create project specific components.

To provide a proper documentation to the team of other devs & editors, I want to display documentation from my project specific components plus the ones I included from the (community) repositories.

Solution

With these 3 pull requests, my use case would be fully covered:

• feat(docz-core): support kebab & pascal case component file name pattern #1314
• fix(docz-core): properly support node_modules for multiple file patterns #1315
• feat(docz-core): allow custom pattern for globbing components #1316

Todo

The naming of the customPattern should probably be changed to a more clear name 🤔

The code for sure is not bullet proof yet, it also needs some documentation. I also found several other configuration options within docz-core which are not yet reflected on the website. We could tackle these as well :)

Would love to see this integrated, I am very open to feedback to my PRs.

👋

Example

With all PRs applied and the config below I can support components and docs from normal projects and mono/lerna/yarn workspace repositories as well.

{
  resolve: `gatsby-theme-docz`,
  options: {
    files: [
      `src/components/mdx/**/docs/*.{md,markdown,mdx}`,
      `node_modules/@gatsby-mdx-suite/*/docs/*.{md,markdown,mdx}`,
      `../../node_modules/@gatsby-mdx-suite/*/docs/*.{md,markdown,mdx}`,
    ],
    customPattern: [
      `src/components/mdx/**/*.{js,jsx,mjs}`,
      `node_modules/@gatsby-mdx-suite/**/*.{js,jsx,mjs}`,
      `../../node_modules/@gatsby-mdx-suite/**/*.{js,jsx,mjs}`,
    ],
  },
}

[rakannimer]

Thank you for the PRs, I'm sure many people will find them very useful 👍

I merged #1315 and added minor reviews for #1314 and #1316.

Regarding the docs, if you agree with me and we go with docgenConfig.searchPatterns than we could add docs for the complete docgenConfig object in docz.site (https://github.com/doczjs/docz-website)

I opened an issue there to track the progress : doczjs/docz-website#90

[axe312ger]

working now for me in alpha, will report back if issues arise. Thx for the alpha release! :)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.