{"id":15659489,"url":"https://github.com/linusu/ts-readme-generator","last_synced_at":"2025-05-04T07:40:54.344Z","repository":{"id":57381107,"uuid":"223449578","full_name":"LinusU/ts-readme-generator","owner":"LinusU","description":"Generate API documentation straight into the Readme file from TypeScript typings","archived":false,"fork":false,"pushed_at":"2024-08-22T13:03:09.000Z","size":93,"stargazers_count":21,"open_issues_count":3,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T21:04:38.451Z","etag":null,"topics":["documentation-generator","hacktoberfest","readme","typescript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LinusU.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-11-22T17:06:49.000Z","updated_at":"2024-08-22T13:03:13.000Z","dependencies_parsed_at":"2024-01-13T17:11:26.778Z","dependency_job_id":"bb97d321-47d1-405c-8d95-5499487b246e","html_url":"https://github.com/LinusU/ts-readme-generator","commit_stats":{"total_commits":54,"total_committers":1,"mean_commits":54.0,"dds":0.0,"last_synced_commit":"a346ae5627b629757a64a026298205e962aabfa4"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusU%2Fts-readme-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusU%2Fts-readme-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusU%2Fts-readme-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusU%2Fts-readme-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LinusU","download_url":"https://codeload.github.com/LinusU/ts-readme-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252134344,"owners_count":21699700,"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-generator","hacktoberfest","readme","typescript"],"created_at":"2024-10-03T13:17:08.177Z","updated_at":"2025-05-03T02:38:20.799Z","avatar_url":"https://github.com/LinusU.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Generate Readme from TypeScript\n\nSmall tool to automatically generate your API documentation straight into your `readme.md` from your TypeScript typings.\n\n**Note:** This is very much a work in progress. I'm currently going through my projects one by one and replacing the API docs with generated ones, improving this module as I go. Don't expect it to work with most modules just yet.\n\n## Installation\n\n```sh\nnpm install --global ts-readme-generator\n```\n\n## Usage\n\nMake sure that your `readme.md` contains a `## API` section (or `## Props` if it's a React module), then simply run the command to update your Readme file from the TypeScript definitions.\n\n```sh\nts-readme-generator\n```\n\nYou can also run the script in \"check mode\" to make it exit with a non-zero status if the documentation isn't up to date.\n\n```sh\nts-readme-generator --check\n```\n\n## Examples\n\nCheck out these projects using `ts-readme-generator`:\n\n- [`@cwasm/lodepng`](https://github.com/LinusU/cwasm-lodepng)\n- [`append-field`](https://github.com/LinusU/node-append-field)\n- [`base32-encode`](https://github.com/LinusU/base32-encode)\n- [`fs-xattr`](https://github.com/LinusU/fs-xattr)\n- [`load-yaml-file`](https://github.com/LinusU/load-yaml-file)\n- [`react-stacked`](https://github.com/LinusU/react-stacked)\n- [`react-tinder-card`](https://github.com/3DJakob/react-tinder-card)\n- [`server-accepts-email`](https://github.com/LinusU/server-accepts-email)\n- [`to-data-view`](https://github.com/LinusU/to-data-view)\n\nIf you are using this in a public project, please send a PR to add it to this list!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinusu%2Fts-readme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinusu%2Fts-readme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinusu%2Fts-readme-generator/lists"}