{"id":21404194,"url":"https://github.com/pedroo-nietoo/typeorm-docs","last_synced_at":"2026-04-12T22:54:08.915Z","repository":{"id":263837061,"uuid":"891543610","full_name":"Pedroo-Nietoo/TypeORM-Docs","owner":"Pedroo-Nietoo","description":"Generate HTML and Markdown documentation from TypeORM entities","archived":false,"fork":false,"pushed_at":"2024-11-25T16:08:38.000Z","size":543,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T03:30:26.853Z","etag":null,"topics":["docs","documentation","html","markdown","typeorm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/typeorm-docs","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/Pedroo-Nietoo.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-20T14:20:42.000Z","updated_at":"2024-11-25T16:08:44.000Z","dependencies_parsed_at":"2024-11-20T22:15:08.131Z","dependency_job_id":null,"html_url":"https://github.com/Pedroo-Nietoo/TypeORM-Docs","commit_stats":null,"previous_names":["pedroo-nietoo/typeorm-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedroo-Nietoo%2FTypeORM-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedroo-Nietoo%2FTypeORM-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedroo-Nietoo%2FTypeORM-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedroo-Nietoo%2FTypeORM-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pedroo-Nietoo","download_url":"https://codeload.github.com/Pedroo-Nietoo/TypeORM-Docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243902241,"owners_count":20366258,"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":["docs","documentation","html","markdown","typeorm"],"created_at":"2024-11-22T16:13:25.955Z","updated_at":"2026-04-12T22:54:08.863Z","avatar_url":"https://github.com/Pedroo-Nietoo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeORM Docs\n\n![Project Banner](https://raw.githubusercontent.com/Pedroo-Nietoo/TypeORM-Docs/refs/heads/main/images/project_image.png)\n\n## Overview\n\nThe `typeorm-docs` is a simple command-line tool that generates HTML and Markdown documentation for your TypeORM entities. This package reads your entities located on the `src/entities` folder and produces an easy-to-read documentation format for your models and their fields, including attributes like `id`, `type`, `primary and foreign keys`, and `relations`.\n\n\n\u003cbr\u003e\n\n## Usage\n\n### Installation\n\nTo install `typeorm-docs`, use npm:\n\n```bash\nnpm install typeorm-docs\n```\n\nOr, if you prefer to install it globally:\n\n```bash\nnpm install -g typeorm-docs\n```\n\n### Generating Documentation\nOnce installed, you can generate documentation by running the following command:\n\n```bash\nnpx typeorm-docs\n```\n\nOr, if you prefer to generate the documentation on dark mode:\n\n```bash\nnpx typeorm-docs -d\n```\n\nThis will create an `index.html` file in the `docs` directory, containing the generated documentation from your `src/entities` folder.\n\nTo use `typeorm-docs`, ensure you have your TypeORM entities in the `src/entities` directory of your project. The command will look for the entities and generate the documentation based on their content.\n\n\u003cbr\u003e\n\n## Contributing\nContributions are welcome! If you would like to contribute, please fork the repository, add your changes, and submit a pull request. Please ensure your code adheres to the project's coding standards and includes tests. Make sure to send a detailed description of your changes and why you made them, as long as a image/gif/video that shows the changes.\n\n\u003cbr\u003e\n\n## Testing\nTo run tests for the package, you can use Jest. First, ensure you have installed the dependencies, then run:\n\n```bash\nnpm test\n```\n\n\u003cbr\u003e\n\n## License\nThis package is licensed under the MIT License. See the LICENSE file for more details.\n\n\n© 2024 [Pedroo-Nietoo](https://github.com/Pedroo-Nietoo)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedroo-nietoo%2Ftypeorm-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpedroo-nietoo%2Ftypeorm-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedroo-nietoo%2Ftypeorm-docs/lists"}