{"id":22423378,"url":"https://github.com/prantlf/grunt-mkdocs","last_synced_at":"2026-04-29T18:34:49.411Z","repository":{"id":26679217,"uuid":"30135924","full_name":"prantlf/grunt-mkdocs","owner":"prantlf","description":"Grunt plugin generating documentation web site from Markdown sources using mkdocs","archived":false,"fork":false,"pushed_at":"2019-03-15T08:54:13.000Z","size":118,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-22T12:09:24.782Z","etag":null,"topics":["documentation-generator","grunt-plugins","mkdocs"],"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/prantlf.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}},"created_at":"2015-02-01T04:14:51.000Z","updated_at":"2022-02-04T17:08:07.000Z","dependencies_parsed_at":"2022-09-04T14:54:00.545Z","dependency_job_id":null,"html_url":"https://github.com/prantlf/grunt-mkdocs","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/prantlf/grunt-mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prantlf","download_url":"https://codeload.github.com/prantlf/grunt-mkdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mkdocs/sbom","scorecard":{"id":743718,"data":{"date":"2025-08-11","repo":{"name":"github.com/prantlf/grunt-mkdocs","commit":"55ec9572658bda18e5a7507e85e1dc4b59fe1e9d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/10 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":"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":"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":"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":"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":"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":"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"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"46 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-957j-59c2-j692","Warn: Project is vulnerable to: GHSA-m5pj-vjjf-4m3h","Warn: Project is vulnerable to: GHSA-j383-35pm-c5h4","Warn: Project is vulnerable to: GHSA-rm36-94g8-835r","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","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-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","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-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-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","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-22T18:10:57.851Z","repository_id":26679217,"created_at":"2025-08-22T18:10:57.851Z","updated_at":"2025-08-22T18:10:57.851Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32439295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T18:12:22.909Z","status":"ssl_error","status_checked_at":"2026-04-29T18:11:33.322Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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-generator","grunt-plugins","mkdocs"],"created_at":"2024-12-05T18:10:50.257Z","updated_at":"2026-04-29T18:34:49.385Z","avatar_url":"https://github.com/prantlf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-mkdocs\n[![NPM version](https://badge.fury.io/js/grunt-mkdocs.png)](http://badge.fury.io/js/grunt-mkdocs)\n[![Build Status](https://travis-ci.org/prantlf/grunt-mkdocs.png)](https://travis-ci.org/prantlf/grunt-mkdocs)\n[![Coverage Status](https://coveralls.io/repos/prantlf/grunt-mkdocs/badge.svg)](https://coveralls.io/r/prantlf/grunt-mkdocs)\n[![Dependency Status](https://david-dm.org/prantlf/grunt-mkdocs.svg)](https://david-dm.org/prantlf/grunt-mkdocs)\n[![devDependency Status](https://david-dm.org/prantlf/grunt-mkdocs/dev-status.svg)](https://david-dm.org/prantlf/grunt-mkdocs#info=devDependencies)\n[![devDependency Status](https://david-dm.org/prantlf/grunt-mkdocs/peer-status.svg)](https://david-dm.org/prantlf/grunt-mkdocs#info=peerDependencies)\n[![Code Climate](https://codeclimate.com/github/prantlf/grunt-mkdocs/badges/gpa.svg)](https://codeclimate.com/github/prantlf/grunt-mkdocs)\n[![Codacy Badge](https://www.codacy.com/project/badge/f3896e8dfa5342b8add12d50390edfcd)](https://www.codacy.com/public/prantlf/grunt-mkdocs)\n[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)\n\n[![NPM Downloads](https://nodei.co/npm/grunt-mkdocs.png?downloads=true\u0026stars=true)](https://www.npmjs.com/package/grunt-mkdocs)\n\n\u003e Grunt plugin generating documentation web site from Markdown sources\n  using mkdocs\n\n## Getting Started\n\nYou need [node \u003e= 0.8][node], [npm] and [grunt \u003e= 0.4][Grunt] installed\nand your project build managed by a [Gruntfile] with the necessary modules\nlisted in [package.json].  If you haven't used Grunt before, be sure to\ncheck out the [Getting Started] guide, as it explains how to create a\nGruntfile as well as install and use Grunt plugins.  Once you're familiar\nwith that process, you may install this plugin with this command:\n\n```shell\n$ npm install grunt-mkdocs --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile\nwith this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-mkdocs');\n```\n\n## The \"mkdocs\" tool\n\nThis plugin depends on the [mkdocs] documentation web site generator,\nwhich can produce HTML files and other assets suitable for upload to\nthe [Read The Docs] web site.  You must install it before you build\nthe documentation.\n\nYou need [Python] and [pip] installed, then you install the mkdocs package:\n\n```shell\n$ sudo pip install mkdocs\n```\n\n## Input\n\nStore your written articles in to a folder (docs) and specify a target\nfolder for the generated HTML pages (site); the index.md file will become\nthe title page:\n\n```text\ndocs/\n  index.md\n  overview.md\n  ...\nsite/\n overview/\n index.html\n ...\nmkdocs.yml\nGruntfile.js\n```\n\n## The \"mkdocs\" task\n\nThis module provides a grunt multi-task generating HTML documentation from\nMarkdown sources using [mkdocs].  In your project's Gruntfile, add a section\nnamed `mkdocs` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n  mkdocs: {\n    dist: {\n      src: '.',\n      options: {\n        clean: true\n      }\n    }\n  }\n})\n```\n\nAll documentation project options should be maintained in the\n[mkdocs configuration] file (mkdocs.yml) in this plugin version.\n\n### Options\n\n#### src\nType: `String`\nDefault value: `'.'`\n\nPath to documentation root directory with the `mkdocs.yml` file.\n\n#### options.clean\nType: `Boolean`\nDefault value: `false`\n\nRemoves stale files (from previous builds) from the target folder.\n\n## Build\n\nCall the `mkdocs` task:\n\n```shell\n$ grunt mkdocs\n```\n\nor integrate it to the default build sequence in the Gruntfile:\n\n```js\ngrunt.registerTask('default', ['mkdocs', ...]);\n```\n\n## Notes\n\nIf you want to browse the generated web site from the file system (using\nthe `file://` scheme), add the option `use_directory_urls: false` to the\n`mkdocs.yml` configuration files.  The generated links will point to\n`.../index.html` files instead of just `.../` directories relying on the\ndefault documents supported by the web servers.\n\n## Contributing\n\nIn lieu of a formal styleguide, take care to maintain the existing coding\nstyle.  Add unit tests for any new or changed functionality. Lint and test\nyour code using Grunt.\n\n## Release History\n\n * 2018-04-27   v1.0.0   Dropped support of Node.js 4\n * 2016-02-24   v0.2.3   Upgrade dependencies\n * 2016-26-08   v0.2.0   Upgrade to Grunt 1.x\n * 2015-07-30   v0.1.0   Initial release\n\n## License\n\nCopyright (c) 2015-2019 Ferdinand Prantl\n\nLicensed under the MIT license.\n\n[node]: http://nodejs.org\n[npm]: http://npmjs.org\n[package.json]: https://docs.npmjs.com/files/package.json\n[Grunt]: https://gruntjs.com\n[Gruntfile]: http://gruntjs.com/sample-gruntfile\n[Getting Gtarted]: https://github.com/gruntjs/grunt/wiki/Getting-started\n[Python]: https://www.python.org\n[pip]: http://pip.readthedocs.org/en/latest/installing.html\n[mkdocs]: http://www.mkdocs.org\n[mkdocs configuration]: http://www.mkdocs.org/user-guide/configuration\n[Read The Docs]: https://readthedocs.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprantlf%2Fgrunt-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-mkdocs/lists"}