{"id":16222513,"url":"https://github.com/schoero/unwritten","last_synced_at":"2026-02-18T07:31:50.987Z","repository":{"id":191066016,"uuid":"570979041","full_name":"schoero/unwritten","owner":"schoero","description":"unwritten automatically generates documentation from your JavaScript or TypeScript library by utilizing JSDoc comments and the TypeScript compiler.","archived":false,"fork":false,"pushed_at":"2025-01-20T19:01:06.000Z","size":4255,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-20T02:40:22.236Z","etag":null,"topics":["docs","documentation","documentation-generator","javascript","jsdoc","tsdoc","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/schoero.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":"FUNDING.yml","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,"zenodo":null},"funding":{"github":["schoero"]}},"created_at":"2022-11-26T18:54:16.000Z","updated_at":"2025-07-03T07:23:30.000Z","dependencies_parsed_at":"2023-08-28T00:06:46.377Z","dependency_job_id":"c9dbee3f-29c1-4273-b0de-964f8cbd65a8","html_url":"https://github.com/schoero/unwritten","commit_stats":null,"previous_names":["schoero/unwritten"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/schoero/unwritten","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schoero%2Funwritten","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schoero%2Funwritten/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schoero%2Funwritten/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schoero%2Funwritten/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schoero","download_url":"https://codeload.github.com/schoero/unwritten/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schoero%2Funwritten/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29572397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T06:19:27.422Z","status":"ssl_error","status_checked_at":"2026-02-18T06:18:44.348Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","documentation-generator","javascript","jsdoc","tsdoc","typescript"],"created_at":"2024-10-10T12:14:26.281Z","updated_at":"2026-02-18T07:31:50.948Z","avatar_url":"https://github.com/schoero.png","language":"TypeScript","funding_links":["https://github.com/sponsors/schoero"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"assets/unwritten-dark.svg\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"assets/unwritten-light.svg\"\u003e\n    \u003cimg alt=\"unwritten\" src=\"assets/unwritten.svg\"\u003e\n  \u003c/picture\u003e\n\u003c/div\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n  [![GitHub license](https://img.shields.io/github/license/schoero/unwritten?style=flat-square\u0026labelColor=454c5c\u0026color=00AD51)](https://github.com/schoero/unwritten/blob/main/LICENSE)\n  [![npm version](https://img.shields.io/npm/v/unwritten?style=flat-square\u0026labelColor=454c5c\u0026color=00AD51)](https://www.npmjs.com/package/unwritten?activeTab=versions)\n  [![GitHub issues](https://img.shields.io/github/issues/schoero/unwritten?style=flat-square\u0026labelColor=454c5c\u0026color=00AD51)](https://github.com/schoero/unwritten/issues)\n  [![npm weekly downloads](https://img.shields.io/npm/dw/unwritten?style=flat-square\u0026labelColor=454c5c\u0026color=00AD51)](https://www.npmjs.com/package/unwritten?activeTab=readme)\n  [![GitHub repo stars](https://img.shields.io/github/stars/schoero/unwritten?style=flat-square\u0026labelColor=454c5c\u0026color=00AD51)](https://github.com/schoero/unwritten/stargazers)\n  [![GitHub workflow status](https://img.shields.io/github/actions/workflow/status/schoero/unwritten/ci.yml?event=push\u0026style=flat-square\u0026labelColor=454c5c\u0026color=00AD51)](https://github.com/schoero/unwritten/actions?query=workflow%3ACI)\n\n\u003c/div\u003e\n\n---\n\nunwritten is a cli tool to automatically generate documentation from your JavaScript or TypeScript library by utilizing JSDoc comments and the TypeScript compiler to extract types and relevant information.\n\n\u003e [!WARNING]\n\u003e\n\u003e This project is at a really early stage and currently under heavy development. It is not feature complete and it may not or only partially work with your project. You have been warned.\n\n## Installation\n\n```sh\nnpm i unwritten\n```\n\n## Usage\n\n```sh\nunwritten \u003cpath/to/entry-file.ts\u003e [options]\n```\n\n## Options\n\n```sh\n--output \u003cpath/to/output/file-name\u003e     # Specify the output directory and the\n-o \u003cpath/to/output/file-name\u003e           # file name. Defaults to ./docs/api \n                                        # based on the current working \n                                        # directory.\n\n--tsconfig \u003cpath/to/tsconfig.json\u003e      # Provide a tsconfig file used to\n-t \u003cpath/to/tsconfig.json\u003e              # compile your project. unwritten will\n                                        # try to find the tsconfig by itself if\n                                        # no tsconfig.json is provided.\n\n--config \u003cpath/to/.unwritten.json\u003e      # Provide an unwritten config used to\n-c \u003cpath/to/.unwritten.json\u003e            # render the documentation. unwritten\n                                        # will try to find the .unwritten.json\n                                        # config by itself if none is provided\n                                        # or uses the default config.\n\n--renderer \u003cmd | html | json\u003e           # Choose the format of the rendered \n-r \u003cmd | html | json\u003e                   # output. Defaults to `md` for markdown.\n                                        # It is also possible to provide a\n                                        # custom renderer by providing the path\n                                        # to the file that default exports the \n                                        # renderer.\n\n--silent                                # Disables any console output.\n-s\n\n--debug                                 # Enables verbose console output.\n-d\n\n--version                               # Returns the installed unwritten\n-v                                      # version.\n```\n\n## Configuration\n\nYou can configure how your documentation will be rendered using a configuration file. The simplest way to create such a configuration file is by using the following command:\n\n```sh\nunwritten init\n```\n\nThis will create a `.unwritten.json` file in the current working directory with the default configuration. You can change or remove any of the options in the configuration file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschoero%2Funwritten","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschoero%2Funwritten","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschoero%2Funwritten/lists"}