{"id":21451469,"url":"https://github.com/db-developer/grunt-typedoc2md","last_synced_at":"2026-03-11T01:02:46.805Z","repository":{"id":248081752,"uuid":"827701209","full_name":"db-developer/grunt-typedoc2md","owner":"db-developer","description":"convert typedoc to markdown","archived":false,"fork":false,"pushed_at":"2024-07-12T17:47:45.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-27T07:28:25.215Z","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/db-developer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2024-07-12T07:38:44.000Z","updated_at":"2024-07-12T17:47:48.000Z","dependencies_parsed_at":"2024-07-12T09:25:31.278Z","dependency_job_id":null,"html_url":"https://github.com/db-developer/grunt-typedoc2md","commit_stats":null,"previous_names":["db-developer/grunt-typedoc2md"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/db-developer%2Fgrunt-typedoc2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/db-developer%2Fgrunt-typedoc2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/db-developer%2Fgrunt-typedoc2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/db-developer%2Fgrunt-typedoc2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/db-developer","download_url":"https://codeload.github.com/db-developer/grunt-typedoc2md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242774376,"owners_count":20183071,"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-23T04:22:17.972Z","updated_at":"2025-12-13T13:15:24.538Z","avatar_url":"https://github.com/db-developer.png","language":"JavaScript","readme":"# grunt-typedoc2md\n\nconvert typedoc to markdown.\n\n[![npm version](https://img.shields.io/npm/v/grunt-typedoc2md?color=blue)](https://www.npmjs.com/package/grunt-typedoc2md)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![jsdoc](https://img.shields.io/static/v1?label=jsdoc\u0026message=%20api%20\u0026color=blue)](https://jsdoc.app/)\n[![Built with Grunt](https://cdn.gruntjs.com/builtwith.svg)](https://gruntjs.com/)\n[![codecov](https://codecov.io/gh/db-developer/grunt-typedoc2md/branch/master/graph/badge.svg)](https://codecov.io/gh/db-developer/grunt-typedoc2md)\n[![Build Status](https://travis-ci.com/db-developer/grunt-typedoc2md.svg?branch=master)](https://travis-ci.com/db-developer/grunt-typedoc2md)\n[![dependencies](https://img.shields.io/librariesio/release/npm/grunt-typedoc2md)](https://libraries.io/)\n\n## content ##\n\n* Usage (see further down this page)\n  * [Prerequisites](#prerequisites)\n  * [Getting started guide](#getting-started)\n  * [Usage and examples](#usage)\n\n* Developers\n  * [Testing grunt-typedoc2md](docs/grunt.md#testing)\n  * [Code coverage of tests for grunt-typedoc2md](docs/grunt.md#code-coverage)\n  * [Build grunt-typedoc2md from scratch](docs/grunt.md#building)\n  * [NPM integration of grunt-typedoc2md](docs/grunt.md#npm_integration)\n  * [Frameworks used for testing, building, etc.](docs/frameworks.md)\n  * [API of package grunt-typedoc2md](docs/api.index.md)\n\n[Changelog](CHANGELOG.md)\n\n## prerequisites ##\n\nThis plugin is independent from any specific **version** of\n* [typedoc](https://www.npmjs.com/package/typedoc)\n* [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown)\n\n**Nevertheless BOTH packages MUST be installed before running 'grunt-typedoc2md'**\n\n## getting started ##\n\nThis guide assumes, that you are familiar with the use of\n[npm](https://npmjs.com \"Homepage of npm\") and\n[grunt](https://gruntjs.com \"Homepage of grunt\").  \nThe plugin can be installed by the following command:\n\n\u003ccode\u003enpm install grunt-typedoc2md --save-dev\u003c/code\u003e\n\nOnce installed, the plugin may be loaded from within your gruntfile:\n\n\u003ccode\u003egrunt.loadNpmTasks( \"grunt-typedoc2md\" );\u003c/code\u003e\n\nSetup the task configuration as described below (see usage) and run the task:\n\n\u003ccode\u003egrunt typedoc2md\u003c/code\u003e\n\nOf cause, the task can be integrated into any complex build process.\n\n## usage ##\n\nThe following examples assume that the grunt plugin 'load-grunt-config' is used.\nAlternatively, the code can of course be integrated into the 'gruntfile.js' file.  \n\n```javascript\n// file typedoc2md.js\nmodule.exports = function ( grunt, options ) {\n  return {\n    options: {\n      \"config\": \"./conf/typedoc/typedoc.json\"           // MUST be of JSON format\n    },\n    always: {\n    },\n    other: {\n      \"config\": \"./conf/typedoc/other.typedoc.json\",    // MUST be of JSON format\n      \"typedoc-plugin-markdown\": false,                 // In case you explicitly may not want to create markdown ;-)\n      \"plugin\": [ \"any\", \"other\", \"typedoc\", \"plugin\" ]\n    }\n  };\n};\n```\n\nSee [typedoc guide](https://typedoc.org/guides/overview/) for settings, that can be used in typedoc.json.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdb-developer%2Fgrunt-typedoc2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdb-developer%2Fgrunt-typedoc2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdb-developer%2Fgrunt-typedoc2md/lists"}