{"id":15540936,"url":"https://github.com/thundermiracle/storybook-loader","last_synced_at":"2026-03-12T08:36:09.727Z","repository":{"id":39557298,"uuid":"168465546","full_name":"thundermiracle/storybook-loader","owner":"thundermiracle","description":"auto-load all files from a folder by wepack's require.context without writing *.stories.js","archived":false,"fork":false,"pushed_at":"2022-12-10T16:48:11.000Z","size":3374,"stargazers_count":3,"open_issues_count":52,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-20T11:18:26.285Z","etag":null,"topics":["documentation","loader","react","storybook","storybook-loader"],"latest_commit_sha":null,"homepage":"https://thundermiracle.github.io/storybook-loader","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thundermiracle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-31T04:58:19.000Z","updated_at":"2021-05-03T18:47:28.000Z","dependencies_parsed_at":"2023-01-26T10:46:10.196Z","dependency_job_id":null,"html_url":"https://github.com/thundermiracle/storybook-loader","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/thundermiracle/storybook-loader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundermiracle%2Fstorybook-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundermiracle%2Fstorybook-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundermiracle%2Fstorybook-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundermiracle%2Fstorybook-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thundermiracle","download_url":"https://codeload.github.com/thundermiracle/storybook-loader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundermiracle%2Fstorybook-loader/sbom","scorecard":{"id":883568,"data":{"date":"2025-08-11","repo":{"name":"github.com/thundermiracle/storybook-loader","commit":"e266e9ef97dc2b6d065f914df241c075f39a9678"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"checks":[{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"144 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3","Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx","Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-779f-wgxg-qr8f","Warn: Project is vulnerable to: GHSA-ccrp-c664-8p4j","Warn: Project is vulnerable to: GHSA-4wx3-54gh-9fr9","Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-wvhm-4hhf-97x9","Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w","Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg","Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96","Warn: Project is vulnerable to: GHSA-3949-f494-cm99","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x","Warn: Project is vulnerable to: GHSA-33vh-7x8q-mg35","Warn: Project is vulnerable to: GHSA-79xf-67r4-q2jj","Warn: Project is vulnerable to: GHSA-9pcf-h8q9-63f6","Warn: Project is vulnerable to: GHSA-hcg3-56jf-x4vh","Warn: Project is vulnerable to: GHSA-hrpq-r399-whgw","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx","Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq","Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v","Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx","Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p","Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3","Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v","Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442","Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc","Warn: Project is vulnerable to: GHSA-rqff-837h-mm52","Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2","Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j","Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-mh2h-6j8q-x246","Warn: Project is vulnerable to: GHSA-5q88-cjfq-g2mh","Warn: Project is vulnerable to: GHSA-xp63-6vf5-xf3v","Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-w5hq-hm5m-4548","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T09:12:15.983Z","repository_id":39557298,"created_at":"2025-08-24T09:12:15.983Z","updated_at":"2025-08-24T09:12:15.983Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30420520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-12T07:30:13.030Z","status":"ssl_error","status_checked_at":"2026-03-12T07:29:54.885Z","response_time":114,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","loader","react","storybook","storybook-loader"],"created_at":"2024-10-02T12:14:50.881Z","updated_at":"2026-03-12T08:36:09.708Z","avatar_url":"https://github.com/thundermiracle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\nstorybook-loader\n\n\u003c/h1\u003e\n\n[![npm version](https://badge.fury.io/js/storybook-loader.svg)](https://badge.fury.io/js/storybook-loader)\n[![Build Status](https://travis-ci.org/thundermiracle/storybook-loader.svg)](https://travis-ci.org/thundermiracle/storybook-loader)\n[![dependencies Status](https://david-dm.org/thundermiracle/storybook-loader/status.svg)](https://david-dm.org/thundermiracle/storybook-loader)\n[![devDependencies Status](https://david-dm.org/thundermiracle/storybook-loader/dev-status.svg)](https://david-dm.org/thundermiracle/storybook-loader?type=dev)\n[![codecov](https://codecov.io/gh/thundermiracle/storybook-loader/branch/master/graph/badge.svg)](https://codecov.io/gh/thundermiracle/storybook-loader)\n\n## Description in Medium\n\n### [auto-load all stories in storybook by storybook-load](https://medium.com/@thundermiracle/auto-load-all-stories-in-storybook-by-storybook-loader-39f4a5b78d03)\n\n## Table of Contents\n\n* [Description](#Description)\n* [Installation](#Installation)\n* [How to use](#How-to-use)\n  * [Steps of loading javascript component](#steps-of-loading-javascript-component)\n  * [Steps of loading markdown](#steps-of-loading-markdown)\n  * [Steps of loading javascript component with markdown](#Steps-of-loading-javascript-component-with-markdown)\n* [Examples](#Examples)\n* [Instructions](#Instructions)\n  * [parameter](#parameter)\n  * [options](#options)\n    * [storySubFuncList](#storySubFuncList)\n    * [contentFuncList](#contentFuncList)\n    * [hierarchyRoot](#hierarchyRoot)\n    * [groupByFolder](#groupByFolder)\n    * [thirdParamMaker](#thirdParamMaker)\n    * [sort](#sort)\n    * [sortFunc](#sortFunc)\n    * [noExt](#noExt)\n    * [noExtRegExp](#noExtRegExp)\n    * [includeRegExp](#includeRegExp)\n    * [excludeRegExp](#excludeRegExp)\n    * [ignoreDotFolder](#ignoreDotFolder)\n    * [dotFolderName](#dotFolderName)\n  * [third parameter options](#third-parameter-options)\n    * [loader](#loader)\n    * [formatter](#formatter)\n\n## Description\n\nstorybook-loader is a package for [storybook](https://github.com/storybooks/storybook) to automatically load ALL files in a folder.\n\nstorybook-loader analyze the webpack's [require.context](https://webpack.js.org/guides/dependency-management/#requirecontext) return value and load the analyzed results to storyies.\n\nAfter finishing the configuration, you will be free from manually adding story, as storybook-loader will load it for you automatically.\n\n## Installation\n\nstorybook-loader is available as an [npm package](https://www.npmjs.org/package/storybook-loader).\n\n```sh\nnpm install --save--dev storybook-loader\n```\n\n## How to use\n\n### Steps of loading javascript component\n\n1. Create xxx.stories.js under the target folder.\n\n    ```js\n    import { loadJSStories } from 'storybook-loader';\n\n    const req = require.context('./');\n\n    loadJSStories(req);\n    ```\n\n2. Create sub folder and add js files.\n\n   The following structure:\n    ```\n    ./rootPattern1.js\n    ./folder1/pattern1.js\n    ./folder1/pattern2.js\n    ./folder2/pattern1.jsx\n    ./folder2/pattern2.jsx\n    ```\n\n   will display like this(rootPattern1 will be ignored):\n    ```\n    folder1\n    |-pattern1\n    |-pattern2\n    folder2\n    |-pattern1\n    |-pattern2\n    ```\n\n### Steps of loading markdown\n\n1. Create xxx.stories.js under the target folder.\n\n   storybook 4.x\n    ```js\n    import { loadMDStories } from 'storybook-loader';\n    import { doc } from 'storybook-readme';\n\n    const req = require.context('./');\n    const options = {\n      // decorate md's content\n      contentFuncList: [\n        doc,\n      ],\n      // [optional] hide AddOnPanel\n      storySubFuncList: [\n        [\n          'addParameters',\n          [{ options: { showAddonPanel: false } }],\n        ],\n      ],\n    }\n\n    loadMDStories(req, options);\n    ```\n\n   storybook 5.x\n    ```js\n    import { loadMDStories } from 'storybook-loader';\n    import { doc } from 'storybook-readme';\n\n    const req = require.context('./');\n    const options = {\n      // decorate md's content\n      contentFuncList: [\n        doc,\n      ],\n      // [optional] hide AddOnPanel\n      storySubFuncList: [\n        [\n          'addParameters',\n          [{ options: { showPanel: false } }],\n        ],\n      ],\n    }\n\n    loadMDStories(req, options);\n    ```\n\n2. Create sub folder and add md files.\n\n   The following structure:\n    ```\n    ./rootPattern1.md\n    ./folder1/pattern1.md\n    ./folder1/pattern2.md\n    ./folder2/pattern1.md\n    ./folder2/pattern2.md\n    ```\n\n   will display like this(rootPattern1 will be ignored):\n    ```\n    folder1\n    |-pattern1\n    |-pattern2\n    folder2\n    |-pattern1\n    |-pattern2\n    ```\n\n### Steps of loading javascript component with markdown\n\nWhen you not only like to load js components, but also show notes in control panel.\n\n1. Create xxx.stories.js under the target folder.\n\n   storybook 4.x\n    ```js\n    import { loadJSWithNotesStories } from 'storybook-loader';\n    import { withNotes } from '@storybook/addon-notes';\n\n    const req = require.context('./');\n    const options = {\n      // [optional] you can also addDecorator(withNotes) in config.js\n      storySubFuncList: [\n        [\n          'addDecorator',\n          [withNotes],\n        ],\n      ],\n    };\n\n    loadJSWithNotesStories(reqList, options);\n    ```\n\n    storybook 5.x\n    ```js\n    import { loadJSWithNotesStories } from 'storybook-loader';\n\n    const req = require.context('./');\n\n    loadJSWithNotesStories(reqList);\n    ```\n\n2. Create sub folder and add md files.\n\n   The following structure:\n    ```\n    ./folder1/pattern1.js\n    ./folder1/pattern1.md\n    ./folder1/pattern2.js\n    ./folder1/pattern2.md\n    ./folder2/pattern1.jsx\n    ./folder2/pattern1.md\n    ./folder2/pattern2.jsx\n    ```\n\n   will display like this\n    ```\n    folder1\n    |-pattern1 (display folder1/pattern1.md in notes panel)\n    |-pattern2 (display folder1/pattern2.md in notes panel)\n    folder2\n    |-pattern1 (display folder2/pattern1.md in notes panel)\n    |-pattern2 (display nothing in notes panel)\n    ```\n\n## Examples\n\n[./docs/stories/1. Examples](/docs/stories/1.%20Examples)\n\n## Instructions\n\n### **parameter**\n\n| No.   | Parameter | Required | Type | Default | Description |\n|:------|:---------:|:--------:|:----:|:--------|:------------|\n| 1 | requireContext | 〇 | object / object list |  | instance of require.context OR an object return the same architecture to require.context |\n| 2 | options | | object | ```{ groupByFolder: true, folderNameWhenEmpty: 'ALL' }``` | *see [options](#options) below for more details |\n| 3 | thirdParamMakerOptions |  | object | ```{ loader: mdLoader, formatter: formatWithNotesObject }``` | *see [options](#third-parameter-options) below for more details |\n\n### **options**\n\n#### storySubFuncList\n\n   * Default: []\n\n   * Description: list of sub functions in storiesOf to call\n\n   * Attention: parameters of sub function MUST be an array\n\n   * Example:\n\n          -- NO.1 --------------------------------------------------------\n          storySubFuncList: [ \n            'subFunc1',\n            [ 'addDecorator', [withNotes] ],\n            [ 'addParameters', [{ options: { showPanel: false } }] ],\n          ]\n          ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n          stories.subFunc1();\n          stories.addDecorator(withNotes);\n          stories.addParameters({ options: { showPanel: false } });\n\n#### contentFuncList\n\n  * Default: [ ramda.identity ] \n\n  * Description: list of pure functions for decorating file's contents. It's useful when you want to apply hocs(High Order Component) or hofs(High Order Function) to your content like withMUITheme, withLayout...\n\n  * Attention: functions will receive ONLY ONE parameter -- the contents (could be string or React.Component). If function has more than one parameters, you can use util.unaryFunc to apply the rest parameters and then pass it to contentFuncList.\n\n  * Example:\n\n        -- NO.1 --------------------------------------------------------\n        function decPrefixMsg(content, msg) {\n          return `${msg}: ${content}`;\n        }\n\n        contentFuncList: [ \n          util.unaryFunc(decPrefixMsg, ['MyMessage is']),\n        ]\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        stories.add(fileName, decPrefixMsg(content, 'MyMessage is'));\n\n        -- NO.2 --------------------------------------------------------\n        contentFuncList: [ \n          withMUITheme,\n          withLayout,\n        ]\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        stories.add(fileName, withLayout(withMUITheme(content)));\n\n#### hierarchyRoot\n\n  * Default: ''\n\n   * Description: prefix of stories' name. If you've enabled [hierarchyRootSeparator](https://github.com/storybooks/storybook/tree/next/addons/options#set-options-globally), xxx| will be the name of hierarchyRoot.\n\n   * Example:\n      \n         -- NO.1 --------------------------------------------------------\n         hierarchyRoot: 'Components|'\n         ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n         storiesOf('Components|' + folderName, module);\n\n#### groupByFolder\n\n  * Default: true\n\n  * Description: use folder name as the root stories' name.\n\n  * Attention: If you set groupByFolder to false, all stories will be added to ONE root named by folderNameWhenEmpty(default is ALL).\n\n  * Example:\n      \n        -- NO.1 --------------------------------------------------------\n        groupByFolder: true\n\n        /Button/Pattern1.js\n        /Button/Pattern2.js\n        /TextField/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        Button\n          - Pattern1\n          - Pattern2\n        TextField\n          - Pattern1\n          \n        -- NO.2 --------------------------------------------------------\n        groupByFolder: false\n\n        /Button/Pattern1.js\n        /Button/Pattern2.js\n        /TextField/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        ALL\n          - Pattern1 (the second Pattern1 will be ignored)\n          - Pattern2\n\n#### thirdParamMaker\n\n  * Default: null\n\n  * Description: function to make 3rd parameter of stories.add(xx, xx, 3rdParam). \n    thirdParamMaker(instance of require.context, filePath).\n\n  * Attention: this function is called after every single file is loaded.\n\n  * Example: [createMDThirdParamMaker](/src/plugin/createMDThirdParamMaker.js)\n\n#### sort\n\n  * Default: true\n\n  * Description: sort files by filename.\n\n#### sortFunc\n\n  * Default: (a, b) =\u003e a.localeCompare(b)\n\n  * Description: sort function. sort by files asc as default.\n\n#### noExt\n\n  * Default: true\n\n  * Description: display filename in menu without extention.\n\n  * Example:\n      \n        -- NO.1 --------------------------------------------------------\n        noExt: true\n\n        /Button/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        Button\n          - Pattern1\n          \n        -- NO.2 --------------------------------------------------------\n        noExt: false\n\n        /Button/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        Button\n          - Pattern1.js\n\n#### noExtRegExp\n\n  * Default: null\n\n  * Description: remove extention regexp.\n\n  * Attention: if noExt is true, will use noExtRegExp \u003e includeRegExp \u003e regExpFromRequireContext.\n\n  * Example: /\\\\.md$/ to remove markdown's extention\n\n#### includeRegExp\n  * Default: null\n\n  * Description: regexp for include files by file's full path.\n\n  * Attention: will use includeRegExp \u003e regExpFromRequireContext.\n\n  * Example: /\\\\.md$/ to add *.md files only.\n    \n#### excludeRegExp\n  * Default: null\n\n  * Description: regexp for exclude files by file's full path.\n\n  * Example: /\\\\.stories.js$/ to exclude all *.stories.js.\n     \n#### ignoreDotFolder\n  * Default: true\n\n  * Description: ignore files under root folder (. folder)\n\n  * Example: \n        -- NO.1 --------------------------------------------------------\n        ignoreDotFolder: true\n\n        ./Pattern1.js\n        /Button/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        Button\n          - Pattern1\n  \n        -- NO.2 --------------------------------------------------------\n        ignoreDotFolder: false\n\n        ./Pattern1.js\n        /Button/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        .\n          - Pattern1\n        Button\n          - Pattern1\n\n#### dotFolderName\n  * Default: .\n\n  * Description: used as folder name when it's a dot(.)\n\n  * Example: \n        -- NO.1 --------------------------------------------------------\n        ignoreDotFolder: false\n        dotFolderName: 'RootFolder'\n\n        ./Pattern1.js\n        /Button/Pattern1.js\n        ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓\n        RootFolder\n          - Pattern1\n        Button\n          - Pattern1\n\n### third parameter options\n\nONLY nessacerry when use loadJSWithNotesStories or loadJsonWithNotesStories. Both of them are using [createMDThirdParamMaker](/src/plugin/createMDThirdParamMaker.js) to make 3rd parameter in stories.add(xx, xx, 3rd param).\n\n#### loader\n  * Default: mdLoader\n\n  * Description: loader to load files for making third param\n\n#### formatter\n  * Default: formatWithNotesObject() in [createMDThirdParamMaker](/src/plugin/createMDThirdParamMaker.js)\n\n  * Description: format the content\n\n  * Example\n      ```js\n      function formatWithNotesObject(content) {\n        return {\n          notes: {\n            markdown: content,\n          },\n        };\n      }\n      ```\n\n## License\n\nThis project is licensed under the terms of the\n[MIT license](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthundermiracle%2Fstorybook-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthundermiracle%2Fstorybook-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthundermiracle%2Fstorybook-loader/lists"}