{"id":21417918,"url":"https://github.com/msg-systems/componentdoc-cli","last_synced_at":"2025-03-16T19:21:18.781Z","repository":{"id":57204821,"uuid":"73202101","full_name":"msg-systems/componentDoc-cli","owner":"msg-systems","description":null,"archived":false,"fork":false,"pushed_at":"2017-03-22T12:30:49.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-15T23:57:11.214Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/msg-systems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-08T15:55:27.000Z","updated_at":"2016-11-09T09:33:36.000Z","dependencies_parsed_at":"2022-09-18T01:00:56.322Z","dependency_job_id":null,"html_url":"https://github.com/msg-systems/componentDoc-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/msg-systems","download_url":"https://codeload.github.com/msg-systems/componentDoc-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243918629,"owners_count":20368745,"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":[],"created_at":"2024-11-22T19:18:08.086Z","updated_at":"2025-03-16T19:21:18.753Z","avatar_url":"https://github.com/msg-systems.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# componentDoc-cli #\r\n\r\nCommand Line Interface for [componentDoc](https://github.com/msg-systems/componentDoc).\r\n\r\n\r\n\r\n## Installation ##\r\n\r\nUse the Node Package Manager (NPM) to install this module locally (default) or globally (with option `-g`):\r\n\r\n\t\t$ npm install [-g] componentDoc-cli\r\n\r\n\r\n## Options ##\r\n\r\nAll Options are optional, beacuse there is a default value for each option.\r\n\r\n- `outputFolder` or `d`  string - path and name of the folder for the generated documentation [**default**: *'bld'*]\r\n- `outputName` or `n`  string - name of the generated documentation (HTML and PDF) [**default**: *'componentDoc'*]\r\n- `template` or `t`  string - path to the template, that should be used for the generation of the documatation\r\n\t\t\t [**default**: is given in the componentDoc module itself]\r\n- `buildPDF` or `p`  string - flag, if a PDF should be created as well [**default**: *'true'*]\r\n- `caption` or `c` string - the caption, that is displayed on the frontpage of the PDF\r\n- `log`  function - function for log information \r\n- `verbose`  function - function for verbose information\r\n- `error`  function - function for error information \r\n\r\n\r\n## License ##\r\n\r\nCopyright (c) 2016 msg systems ag (http://www.msg-systems.com)\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining\r\na copy of this software and associated documentation files (the\r\n\"Software\"), to deal in the Software without restriction, including\r\nwithout limitation the rights to use, copy, modify, merge, publish,\r\ndistribute, sublicense, and/or sell copies of the Software, and to\r\npermit persons to whom the Software is furnished to do so, subject to\r\nthe following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included\r\nin all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\r\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\r\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\r\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\r\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsg-systems%2Fcomponentdoc-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsg-systems%2Fcomponentdoc-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsg-systems%2Fcomponentdoc-cli/lists"}