npm package: @sheriffmoose/storybook-md
Description: Storybook addon for auto importing markdown docs.
Author: Mostafa Sherif
Latest version: 1.0.16
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

<div align="center">

<h1>Markdown Docs</h1>
<p>Storybook addon for auto importing markdown/html docs.</p>

[![][img.release]][link.release]
[![][img.license]][link.license]

[![][img.npm]][link.npm]
[![][img.storybook]][link.npm]

[![][img.banner]][link.npm]
</div>

<h2>Table of Contents</h2>

- [Getting started](#getting-started)
- [Read More](#read-more)

## Getting started

1. Install the addon:

```js
yarn add @sheriffmoose/storybook-md -D
```

2. Add the addon and update the stories imports in your main.js

```js
module.exports = {
    ...
    "stories": [
        "../*.@(md|html)",
        "../src/**/*.stories.@(js|jsx|ts|tsx)"
    ],
    "addons": [
        "@sheriffmoose/storybook-md",
        ...
    ],
    ...
}
```

3. Optionally you may want to pass `mdInclude` and/or `mdExclude` options if needed like so:

```js
module.exports = {
    addons: [
        {
            name: '@sheriffmoose/storybook-md',
            options: {
                mdInclude: path.join(process.cwd(), 'src'),
                mdExclude: [/\.component\.html/] // Disable loading Angular component files
            }
        }
    ]
}
```

That's it, you're done. Now you will find README & CHANGELOG along with HTML docs if you want as well, in your Storybook sidebar and you can open them and see the contents.



## Read More

I have a series of articles written to explain the motivation and purpose behind this addon. Feel free to read through.

* [`Addon-Kit is a developer’s dream come true`](https://sheriffmoose.medium.com/storybook-addon-kit-is-a-developers-dream-come-true-65ab254970d5)
* [`Storybook Markdown Docs (not mdx)`](https://sheriffmoose.medium.com/storybook-markdown-docs-not-mdx-cfa25632ebfc)
* [`Storybook Markdown Docs (not mdx) Part 2`](https://sheriffmoose.medium.com/storybook-markdown-docs-not-mdx-part-2-757463fcad84)
* [`Storybook Addon for Auto Markdown Import`](https://sheriffmoose.medium.com/storybook-addon-for-auto-markdown-import-74f58b6d9c5c)
* [`Support .html files in Storybook`](https://sheriffmoose.medium.com/support-html-files-in-storybook-9e4da45a829a)

Also make sure to check out these PRs that made this addon possible:

* [`storybookjs/storybook #20679 Update Story Indexer to support DocsOnly pages from Markdown/HTML`](https://github.com/storybookjs/storybook/pull/20679)
* [`storybookjs/docs-mdx #10 Add support for Markdown/HTML titles`](https://github.com/storybookjs/docs-mdx/pull/10)











[img.release]:
https://img.shields.io/github/actions/workflow/status/sheriffMoose/storybook-md/release.yml?logo=github&label=release
[img.license]:
https://img.shields.io/github/license/sheriffMoose/storybook-md?logo=github
[img.npm]:
https://img.shields.io/npm/v/@sheriffmoose/storybook-md?logo=npm&logoColor=white&labelColor=CB3837&color=grey&label=
[img.storybook]:
https://img.shields.io/npm/dependency-version/@sheriffmoose/storybook-md/dev/storybook?logo=storybook&logoColor=white&labelColor=FF4785&color=grey&label=
[img.banner]:
https://nodei.co/npm/@sheriffmoose/storybook-md.png

[link.release]:
https://github.com/sheriffMoose/storybook-md/actions/workflows/release.yml
[link.license]:
https://github.com/sheriffMoose/storybook-md/blob/main/LICENSE
[link.npm]:
https://npmjs.org/package/@sheriffmoose/storybook-md