{"id":16372774,"url":"https://github.com/mucsi96/typescript-documentation","last_synced_at":"2025-10-18T16:51:01.510Z","repository":{"id":36347413,"uuid":"223656577","full_name":"mucsi96/typescript-documentation","owner":"mucsi96","description":"Generate markdown API documentation directly from TypeScript source code","archived":false,"fork":false,"pushed_at":"2022-06-20T20:04:14.000Z","size":987,"stargazers_count":20,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-11T21:41:25.599Z","etag":null,"topics":["documentation","generate","generator","markdown","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/mucsi96.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":"2019-11-23T21:39:29.000Z","updated_at":"2023-09-07T13:20:04.000Z","dependencies_parsed_at":"2022-07-16T05:30:32.424Z","dependency_job_id":null,"html_url":"https://github.com/mucsi96/typescript-documentation","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Ftypescript-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Ftypescript-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Ftypescript-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mucsi96%2Ftypescript-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mucsi96","download_url":"https://codeload.github.com/mucsi96/typescript-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244721230,"owners_count":20498913,"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":["documentation","generate","generator","markdown","typescript"],"created_at":"2024-10-11T03:12:22.331Z","updated_at":"2025-10-18T16:50:56.459Z","avatar_url":"https://github.com/mucsi96.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typescript-documentation\n\n[![npm version](https://badge.fury.io/js/typescript-documentation.svg)](https://www.npmjs.com/package/typescript-documentation)\n[![Build Status](https://github.com/mucsi96/typescript-documentation/workflows/Build/badge.svg)](https://github.com/mucsi96/typescript-documentation/actions?query=workflow%3ABuild+branch%3Amaster)\n[![Coverage Status](https://coveralls.io/repos/github/mucsi96/typescript-documentation/badge.svg?branch=master)](https://coveralls.io/github/mucsi96/typescript-documentation?branch=master)\n[![npm](https://img.shields.io/npm/dw/typescript-documentation)](https://www.npmjs.com/package/typescript-documentation)\n[![github](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/mucsi96/typescript-documentation)\n\nGenerate markdown API documentation directly from TypeScript source code.\n\n# Usage\n\n```\nnpm i typescript-documentation\n```\n\n```\n\u003e typescript-documentation [options]\n\nOptions:\n  -p, --project \u003ctsconfig file\u003e  relative or absolute path to a tsconfig.json file (default: \"./tsconfig.json\")\n  -e, --entry \u003cmain file\u003e        entry/main file of project (default: \"./src/index.ts\")\n  -o, --output \u003cmarkdown file\u003e   markdown documentation output file location (default: \"./docs/README.md\")\n  -h, --help                     output usage information\n```\n\n[Live example output](https://mucsi96.gitbook.io/w3c-webdriver/)\n\n# Documenting variables\n\n_Example input:_\n\n```typescript\n/**\n * Simple variable description\n * line 2\n * @see {@link https://test.url.1|Example url 1}\n * @see {@link https://test.url.2|Example url 2}\n * @example\n * example 1 line 1\n * example 1 line 2\n * @example\n * example 2 line 1\n * example 2 line 2\n */\nexport const simpleVariable: number = 1;\n```\n\n_Example output:_\n\n## simpleVariable\n\nSimple variable description\nline 2\n\n**TYPE**\n\nnumber\n\n**EXAMPLES**\n\n```typescript\nexample 1 line 1\nexample 1 line 2\n```\n\n```typescript\nexample 2 line 1\nexample 2 line 2\n```\n\n**SEE ALSO**\n\n- [Example url 1](https://test.url.1)\n- [Example url 2](https://test.url.2)\n\n# Documenting functions\n\n_Example input:_\n\n```typescript\n/**\n * Simple function description\n * line 2\n * @see {@link https://test.url.1|Example url 1}\n * @see {@link https://test.url.2|Example url 2}\n * @example\n * example 1 line 1\n * example 1 line 2\n * @example\n * example 2 line 1\n * example 2 line 2\n * @param a first parameter description\n * @param b second parameter description\n */\nexport function simpleFunction(a: string, b?: number): string {\n  return a;\n}\n```\n\n_Example output:_\n\n## simpleFunction(a, b)\n\nSimple function description\nline 2\n\n**PARAMETERS**\n\n- `a`: string - first parameter description\n- `b?`: number - second parameter description\n\n**RETURNS**\n\nstring\n\n**EXAMPLES**\n\n```typescript\nexample 1 line 1\nexample 1 line 2\n```\n\n```typescript\nexample 2 line 1\nexample 2 line 2\n```\n\n**SEE ALSO**\n\n- [Example url 1](https://test.url.1)\n- [Example url 2](https://test.url.2)\n\n# Documenting classes\n\n_Example input:_\n\n```typescript\n/**\n * Simple class description\n * line 2\n * @see {@link https://test.url.1|Example url 1}\n * @see {@link https://test.url.2|Example url 2}\n * @example\n * example 1 line 1\n * example 1 line 2\n * @example\n * example 2 line 1\n * example 2 line 2\n */\nexport class SimpleClass {\n  /**\n   * simpleMethod1 description\n   * line 2\n   * @see {@link https://test.url.3|Example url 3}\n   * @see {@link https://test.url.4|Example url 4}\n   * @example\n   * example 3 line 1\n   * example 3 line 2\n   * @example\n   * example 4 line 1\n   * example 4 line 2\n   */\n  public simpleMethod1(): void {\n    return;\n  }\n\n  /**\n   * simpleMethod2 description\n   * line 2\n   * @param a first parameter description\n   * @param b second parameter description\n   */\n  public simpleMethod2(a: string, b: number): string {\n    return a + b;\n  }\n}\n```\n\n_Example output:_\n\n## SimpleClass\n\nSimple class description\nline 2\n\n**EXAMPLES**\n\n```typescript\nexample 1 line 1\nexample 1 line 2\n```\n\n```typescript\nexample 2 line 1\nexample 2 line 2\n```\n\n**SEE ALSO**\n\n- [Example url 1](https://test.url.1)\n- [Example url 2](https://test.url.2)\n\n## simpleClass.simpleMethod1()\n\nsimpleMethod1 description\nline 2\n\n**RETURNS**\n\nvoid\n\n**EXAMPLES**\n\n```typescript\nexample 3 line 1\nexample 3 line 2\n```\n\n```typescript\nexample 4 line 1\nexample 4 line 2\n```\n\n**SEE ALSO**\n\n- [Example url 3](https://test.url.3)\n- [Example url 4](https://test.url.4)\n\n## simpleClass.simpleMethod2(a, b)\n\nsimpleMethod2 description\nline 2\n\n**PARAMETERS**\n\n- `a`: string - first parameter description\n- `b`: number - second parameter description\n\n**RETURNS**\n\nstring\n\n# Documenting types\n\n_Example input:_\n\n```typescript\n/**\n * Simple type description\n * line 2\n * @see {@link https://test.url.1|Example url 1}\n * @see {@link https://test.url.2|Example url 2}\n * @example\n * example 1 line 1\n * example 1 line 2\n * @example\n * example 2 line 1\n * example 2 line 2\n */\nexport type SimpleType = {\n  /**\n   * first property description\n   */\n  a: string;\n\n  /**\n   * second property description\n   */\n  b?: number;\n};\n```\n\n_Example output:_\n\n## SimpleType\n\nSimple type description\nline 2\n\n**PROPERTIES**\n\n- `a`: string - first property description\n- `b?`: number - second property description\n\n**EXAMPLES**\n\n```typescript\nexample 1 line 1\nexample 1 line 2\n```\n\n```typescript\nexample 2 line 1\nexample 2 line 2\n```\n\n**SEE ALSO**\n\n- [Example url 1](https://test.url.1)\n- [Example url 2](https://test.url.2)\n\n# Documenting enumerations\n\n_Example input:_\n\n```typescript\n/**\n * Simple enumeration description\n * line 2\n * @see {@link https://test.url.1|Example url 1}\n * @see {@link https://test.url.2|Example url 2}\n * @example\n * example 1 line 1\n * example 1 line 2\n * @example\n * example 2 line 1\n * example 2 line 2\n */\nexport enum SimpleEnum {\n  ONE,\n  TWO\n}\n```\n\n_Example output:_\n\n## SimpleEnum\n\nSimple enumeration description\nline 2\n\n**POSSIBLE VALUES**\n\n- `ONE`\n- `TWO`\n\n**EXAMPLES**\n\n```typescript\nexample 1 line 1\nexample 1 line 2\n```\n\n```typescript\nexample 2 line 1\nexample 2 line 2\n```\n\n**SEE ALSO**\n\n- [Example url 1](https://test.url.1)\n- [Example url 2](https://test.url.2)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmucsi96%2Ftypescript-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmucsi96%2Ftypescript-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmucsi96%2Ftypescript-documentation/lists"}