{"id":20557518,"url":"https://github.com/jsdoc2md/grunt-jsdoc-to-markdown","last_synced_at":"2025-04-14T13:20:47.741Z","repository":{"id":18151368,"uuid":"21245909","full_name":"jsdoc2md/grunt-jsdoc-to-markdown","owner":"jsdoc2md","description":"Markdown API documentation generator","archived":false,"fork":false,"pushed_at":"2021-02-26T23:11:52.000Z","size":151,"stargazers_count":17,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-24T12:26:47.473Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/jsdoc2md.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-26T15:41:17.000Z","updated_at":"2021-02-26T23:11:50.000Z","dependencies_parsed_at":"2022-08-28T05:12:13.846Z","dependency_job_id":null,"html_url":"https://github.com/jsdoc2md/grunt-jsdoc-to-markdown","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fgrunt-jsdoc-to-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fgrunt-jsdoc-to-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fgrunt-jsdoc-to-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fgrunt-jsdoc-to-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsdoc2md","download_url":"https://codeload.github.com/jsdoc2md/grunt-jsdoc-to-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248886334,"owners_count":21177645,"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","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-16T03:37:27.598Z","updated_at":"2025-04-14T13:20:47.701Z","avatar_url":"https://github.com/jsdoc2md.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![view on npm](https://badgen.net/npm/v/grunt-jsdoc-to-markdown)](https://www.npmjs.org/package/grunt-jsdoc-to-markdown)\n[![npm module downloads](https://badgen.net/npm/dt/grunt-jsdoc-to-markdown)](https://www.npmjs.org/package/grunt-jsdoc-to-markdown)\n[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/grunt-jsdoc-to-markdown)](https://github.com/jsdoc2md/grunt-jsdoc-to-markdown/network/dependents?dependent_type=REPOSITORY)\n[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/grunt-jsdoc-to-markdown)](https://github.com/jsdoc2md/grunt-jsdoc-to-markdown/network/dependents?dependent_type=PACKAGE)\n[![Build Status](https://travis-ci.org/jsdoc2md/grunt-jsdoc-to-markdown.svg?branch=master)](https://travis-ci.org/jsdoc2md/grunt-jsdoc-to-markdown)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)\n\n# grunt-jsdoc-to-markdown\n\nA grunt plugin for [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). Accepts the same options as the [`render` method](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md#jsdoc2mdrenderoptions--promise).\n\n## Install\n\n```sh\n$ npm install grunt-jsdoc-to-markdown --save-dev\n```\n\n## Usage\n\nExample `Gruntfile.js`:\n\n```js\n'use strict'\nmodule.exports = function (grunt) {\n  grunt.initConfig({\n    jsdoc2md: {\n      oneOutputFile: {\n        src: 'src/*.js',\n        dest: 'api/documentation.md'\n      },\n      separateOutputFilePerInput: {\n        files: [\n          { src: 'src/jacket.js', dest: 'api/jacket.md' },\n          { src: 'src/shirt.js', dest: 'api/shirt.md' }\n        ]\n      },\n      withOptions: {\n        options: {\n          'no-gfm': true\n        },\n        src: 'src/wardrobe.js',\n        dest: 'api/with-index.md'\n      }\n    }\n  })\n\n  grunt.loadNpmTasks('grunt-jsdoc-to-markdown')\n  grunt.registerTask('default', 'jsdoc2md')\n}\n```\n\n* * *\n\n\u0026copy; 2014-21 Lloyd Brookes \\\u003c75pound@gmail.com\\\u003e.\n\nTested by [test-runner](https://github.com/test-runner-js/test-runner).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc2md%2Fgrunt-jsdoc-to-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsdoc2md%2Fgrunt-jsdoc-to-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc2md%2Fgrunt-jsdoc-to-markdown/lists"}