{"id":18582386,"url":"https://github.com/jrainlau/extract-yaml-from-markdown-plugin","last_synced_at":"2025-08-23T11:09:14.075Z","repository":{"id":114419877,"uuid":"99316276","full_name":"jrainlau/extract-yaml-from-markdown-plugin","owner":"jrainlau","description":"extract yaml information from a markdown file automatically","archived":false,"fork":false,"pushed_at":"2017-08-24T02:32:21.000Z","size":129,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-23T11:06:09.832Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/jrainlau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-04T07:27:16.000Z","updated_at":"2022-03-26T18:33:03.000Z","dependencies_parsed_at":"2023-05-29T10:45:34.162Z","dependency_job_id":null,"html_url":"https://github.com/jrainlau/extract-yaml-from-markdown-plugin","commit_stats":{"total_commits":6,"total_committers":2,"mean_commits":3.0,"dds":"0.33333333333333337","last_synced_commit":"ed799a7122f10770494d948fd1e27e83a5d4a116"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jrainlau/extract-yaml-from-markdown-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jrainlau%2Fextract-yaml-from-markdown-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jrainlau%2Fextract-yaml-from-markdown-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jrainlau%2Fextract-yaml-from-markdown-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jrainlau%2Fextract-yaml-from-markdown-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jrainlau","download_url":"https://codeload.github.com/jrainlau/extract-yaml-from-markdown-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jrainlau%2Fextract-yaml-from-markdown-plugin/sbom","scorecard":{"id":536493,"data":{"date":"2025-08-11","repo":{"name":"github.com/jrainlau/extract-yaml-from-markdown-plugin","commit":"ed799a7122f10770494d948fd1e27e83a5d4a116"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"Code-Review","score":0,"reason":"Found 0/7 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":"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":"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":"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":"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":"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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"}}]},"last_synced_at":"2025-08-20T07:08:00.668Z","repository_id":114419877,"created_at":"2025-08-20T07:08:00.668Z","updated_at":"2025-08-20T07:08:00.668Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271746767,"owners_count":24813582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-07T00:10:52.126Z","updated_at":"2025-08-23T11:09:14.035Z","avatar_url":"https://github.com/jrainlau.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Extract-Yaml-From-Markdown-Plugin\nA webpack plugin for extracting yaml content from a markdown file automatically\n\n# Why\nThis plugin allows people to write `markdown` with `YAML`, then extrct the `YAML` content to a `.json` file.\n\nWhat's more, while under `--watch` mode or `webpack-dev-server`, every changes inside a pointed directory will be detected(adding, changing and deleting), and the new content will be written to a `.json` file automatically.\n\n![Img](/example/img/md.png)\n\n![Img](/example/img/json.png)\n# Install\nYarn: \n```\nyarn add extract-yaml-from-markdown-plugin --dev\n```\n\nNpm: \n```\nnpm install extract-yaml-from-markdown-plugin --save-dev\n```\n\n# Usage\nGo into your `webpack.config.js`, require `extract-yaml-from-markdown-plugin.js`, then init it in the `plugins` option.\n\n```javascript\n// webpack.config.js\n\nconst { resolve } = require('path')\nconst extractYamlFromMarkdownPlugin = require('extract-yaml-from-markdown-plugin.js')\n\nmodule.exports = {\n  plugins: [\n    new extractYamlFromMarkdownPlugin({\n      mdDir: resolve(__dirname, './your-markdown-directory'),\n      output: resolve(__dirname, './output-path-of-you-want')\n    })\n  ]\n}\n```\n\n# Options\n- `mdDir` { String }:\n\n  Your markdown files' directory. After defined, the plugin will be watching this directory. Once you `add`/`update`/`delete` one markdown file, the plugin will update the YAML information and then write them to a `.json` file.\n\n- `output` { String }:\n\n  The plugin will extract YAML information from the given markdown file, then write them to a `.json` file from the path you set to `output`.\n\n- `exclude` { Array }:\n\n  An array of **regEx** that you don't want the plugin to care about.\n\n- `format` { Number }: \n  \n  The plugin using `JSON.stringify()` method to convert an object into string. `format` will be the last param of this method.\n\n# Test\n```\ngit clone https://github.com/jrainlau/extract-yaml-from-markdown-plugin.git\n\ncd extract-yaml-from-markdown-plugin \u0026\u0026 yarn\n\n# using `webpack` command\nyarn test\n\n# using `webpack --watch` command\nyarn test:watch\n\n# using `webpack-dev-server` command\nyarn test:dev-server\n```\nGo to `/example` directory to find out what you got.\n\n# Lisence\nMIT\n  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjrainlau%2Fextract-yaml-from-markdown-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjrainlau%2Fextract-yaml-from-markdown-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjrainlau%2Fextract-yaml-from-markdown-plugin/lists"}