{"id":20336773,"url":"https://github.com/zenvin-dev/documentationgenerator-public","last_synced_at":"2026-03-06T08:01:34.675Z","repository":{"id":171100676,"uuid":"581931041","full_name":"zenvin-dev/DocumentationGenerator-public","owner":"zenvin-dev","description":"A repository to host builds of my Documentation Generator tool, for anyone to use.","archived":false,"fork":false,"pushed_at":"2023-01-08T14:56:02.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T13:46:58.785Z","etag":null,"topics":["automation","documentation-generator","generator","net-core"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zenvin-dev.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":"2022-12-24T23:09:44.000Z","updated_at":"2023-06-19T11:30:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"4ed8181d-9b84-4367-83cb-8e606810ae9c","html_url":"https://github.com/zenvin-dev/DocumentationGenerator-public","commit_stats":null,"previous_names":["xzenvin/documentationgenerator-public","zenvin-dev/documentationgenerator-public"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/zenvin-dev/DocumentationGenerator-public","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenvin-dev%2FDocumentationGenerator-public","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenvin-dev%2FDocumentationGenerator-public/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenvin-dev%2FDocumentationGenerator-public/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenvin-dev%2FDocumentationGenerator-public/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zenvin-dev","download_url":"https://codeload.github.com/zenvin-dev/DocumentationGenerator-public/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenvin-dev%2FDocumentationGenerator-public/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30166856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T07:56:45.623Z","status":"ssl_error","status_checked_at":"2026-03-06T07:55:55.621Z","response_time":250,"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":["automation","documentation-generator","generator","net-core"],"created_at":"2024-11-14T21:06:47.435Z","updated_at":"2026-03-06T08:01:34.601Z","avatar_url":"https://github.com/zenvin-dev.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocumentationGenerator-public\nA repository to host builds of my Documentation Generator tool, for everyone to use.\n\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/xZenvin/DocumentationGenerator-public?label=latest%20release\u0026logoColor=blue\u0026style=for-the-badge\"\u003e\n\u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues-raw/xZenvin/DocumentationGenerator-public?label=open%20issues\u0026style=for-the-badge\"\u003e\n\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\nDocumentation and usage instructions can be found in this repository's \u003ca href=\"https://github.com/xZenvin/DocumentationGenerator-public/wiki\"\u003eWiki\u003c/a\u003e.\n\u003c/p\u003e\n\n---\n\n# Quick Start: Using the CLI\nThe CLI is the main way of interfacing with the DocGen, until the UI is in a working state. \\\nIt can work completely off of command line arguments and thus is perfectly suited to be invoked by shell scripts automating CI. \\\nIf no arguments are given, execution will be interactive and prompts will appear for filling in relevant parameters.\n\n## `documentation`\nThe `documentation` command tells the executable to generate documentation files, based on the given parameters.\n\n### Synopsis\n```\ndocumentation\n  [-s|-settings \u003csettings file path\u003e]\n  [-o|-output \u003coutput directory\u003e]\n  [-version \u003cversion\u003e]\n  [-p|-pause \u003ctrue|false\u003e]\n  [-l \u003clink repository file path\u003e]\n```\n### Options\n- `-s|-settings` (required) \\\n  The path given for this option must be a local file path pointing to a text file in JSON format.\n  The file must contain a valid configuration for the documentation generator.\n- `-o|-output` \\\n  If given a value, this will override the `Output:BaseDirectory` specified in the [Generation Settings](https://github.com/xZenvin/DocumentationGenerator-public/wiki/GenerationSettings#outputsettings).\n- `-version` \\\n  If given a value, this will overwrite the `Input.Version` specified in the generation settings.\n- `-p|-pause` \\\n  If set to `true`, the console will wait for user input after the process has finished or failed.\n  This defaults to `false` and is mainly meant for debugging purposes.\n- `-l` \\\n  If given a value, this will override the `Input:LinkRepository` specified in the [Generation Settings](https://github.com/xZenvin/DocumentationGenerator-public/wiki/GenerationSettings#inputsettings). \\\n  *(Release `pre-0.0.2+`)*\n  \n## `links`\nThe `links` command allows creating a link repository file that can be used in future generation processes to eliminate the need for link prompts.\n  \n### Synopsis\n```\nlinks\n  [-s|-settings \u003csettings file path\u003e]\n  [-o|-output \u003coutput file path\u003e]\n  [-v|-validate \u003ctrue|false\u003e]\n  [-p|-pause \u003ctrue|false\u003e]\n```\n\n### Options\n- `-s|-settings` (required)\\\n  The path given for this option must be a local file path pointing to a text file in JSON format.\n  The file must contain a valid configuration for the documentation generator.\n- `-o|-output` (required)\\\n  The path of the output link repository file. This must be a valid file path.\n  The file extension will automatically be changed to `.zdlr`.\n- `-v|-validate` \\\n  If set to `true`, given links will be validated via web request, and a verification prompt will be given if the request returned an error. \\\n  This defaults to `false`.\n- `-p|-pause` \\\n  If set to `true`, the console will wait for user input after the process has finished or failed.\n  This defaults to `false` and is mainly meant for debugging purposes.\n\n## Exit Codes\nBelow is a table of exit codes that the CLI may return after finishing or failing, and their respective meanings.\n| Code | Reason |\n|-----:|:-------|\n|0     | The process finished without errors. |\n|-1    | The process failed due to an internal error of the generator. |\n|-2    | The process name given was invalid. |\n|-3    | The number of arguments given was invalid. |\n|-4    | The Settings file provided via the `-s\\|-settings` option did not exist or could not be parsed. |\n|-5    | The output path was invalid so that the generation result could not be written. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzenvin-dev%2Fdocumentationgenerator-public","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzenvin-dev%2Fdocumentationgenerator-public","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzenvin-dev%2Fdocumentationgenerator-public/lists"}