@phase2/outline-docs
TypeScript icon, indicating that this package has built-in type declarations

0.0.21 • Public • Published

outline-docs

This provides a base set of documentation about Outline for projects to include in their storybook instances.

The following shows a very minimal sample of how to get the included stories into your Storybook instance.

Use it as a guide to modify your src/.storybook/main.js file or wherever your project is defining config for storybook.

module exports {
  features: {
    storyStoreV7: true,
    postcss: false,
    buildStoriesJson: true,
    modernInlineRender: true,
  },
  framework: {
    name: '@storybook/web-components-vite',
    options: {},
  },
  docs: {
    autodocs: true,
    defaultName: 'Full Documentation', // set to change the name of generated docs entries
  },
  stories: [
    '../components/**/*.stories.@(js|ts|mdx)',
    './stories/!(guides|tokens|demonstration|examples)**/*.stories.@(js|jsx|ts|tsx|mdx)',
  ],
}

Package Sidebar

Install

npm i @phase2/outline-docs

Weekly Downloads

35

Version

0.0.21

License

BSD-3-Clause

Unpacked Size

62 kB

Total Files

27

Last publish

Collaborators

  • nadavoid
  • grshane
  • dmuzyka
  • mkochendorfer
  • pschuelke
  • yuginaili
  • cclarkdev
  • febbraro
  • himerus