@hewes/storybook-addon-docs-graymatter NPM

node-current (scoped)

A Storybook front-matter documentation addon

drop-in for integrating, for example, docusaurus or github docs

Usage

Install

npm install @hewes/storybook-addon-docs-graymatter

Then edit .storybook/main.js

module.exports = {
  "stories": [
    "../docs/**/*.md",
    // ...
  ],
  "addons": [
    {
      name: "@hewes/storybook-addon-docs-graymatter"
    },
    // ...
  ],
}

Options

Option	Description	Default
`prefix`	Prefix the title with this "Folder" i.e. a value of `Documentation` would create titles like `Documentation/Title`, which would therefore be in a sub folder.
`fileNameFallback`	If this is `true` then files without front-matter will still be displayed using the relative filename as the title	`false`

TODO

filename fallback for files without front-matter
sidebar support (to support drop-in from docusaurus)
use https://github.com/atlassian/gray-matter-loader

Reference

gray-matter loader-utils

@infinitebrahmanuniverse/nolb-_hew @everything-registry/sub-chunk-393

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago