Storybook addon for auto importing markdown docs.
Installations
npm install @sheriffmoose/storybook-md
Developer Guide
Typescript
No
Module System
N/A
Min. Node Version
>=16
Node Version
16.19.0
NPM Version
8.19.3
Score
42.2
Supply Chain
83.9
Quality
73
Maintenance
25
Vulnerability
99.6
License
Releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (96.68%)
HTML (3.32%)
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Developer
sheriffMoose
Download Statistics
Total Downloads
2,076
Last Day
1
Last Week
3
Last Month
9
Last Year
237
GitHub Statistics
MIT License
1 Stars
50 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Sep 26, 2024
Sponsor this package
Package Meta Information
Latest Version
1.0.16
Package Id
@sheriffmoose/storybook-md@1.0.16
Unpacked Size
8.77 kB
Size
3.75 kB
File Count
7
NPM Version
8.19.3
Node Version
16.19.0
Published on
Jan 22, 2023
Total Downloads
Cumulative downloads
Total Downloads
2,076
Last Day
0%
1
Compared to previous day
Last Week
0%
3
Compared to previous week
Last Month
-81.3%
9
Compared to previous month
Last Year
-62.2%
237
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
7
Dev Dependencies
26
Table of Contents
Getting started
- Install the addon:
1yarn add @sheriffmoose/storybook-md -D
- Add the addon and update the stories imports in your main.js
1module.exports = { 2 ... 3 "stories": [ 4 "../*.@(md|html)", 5 "../src/**/*.stories.@(js|jsx|ts|tsx)" 6 ], 7 "addons": [ 8 "@sheriffmoose/storybook-md", 9 ... 10 ], 11 ... 12}
- Optionally you may want to pass
mdInclude
and/ormdExclude
options if needed like so:
1module.exports = { 2 addons: [ 3 { 4 name: '@sheriffmoose/storybook-md', 5 options: { 6 mdInclude: path.join(process.cwd(), 'src'), 7 mdExclude: [/\.component\.html/] // Disable loading Angular component files 8 } 9 } 10 ] 11}
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
Storybook Markdown Docs (not mdx)
Storybook Markdown Docs (not mdx) Part 2
Storybook Addon for Auto Markdown Import
Support .html files in Storybook
Also make sure to check out these PRs that made this addon possible:

No vulnerabilities found.

No security vulnerabilities found.