{"id":21417916,"url":"https://github.com/msg-systems/componentdoc","last_synced_at":"2026-01-03T16:08:38.358Z","repository":{"id":57204879,"uuid":"73202070","full_name":"msg-systems/componentDoc","owner":"msg-systems","description":null,"archived":false,"fork":false,"pushed_at":"2017-03-22T12:29:10.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-15T23:57:11.231Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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:05.000Z","updated_at":"2016-11-09T09:33:07.000Z","dependencies_parsed_at":"2022-09-18T01:32:20.074Z","dependency_job_id":null,"html_url":"https://github.com/msg-systems/componentDoc","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","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2FcomponentDoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/msg-systems","download_url":"https://codeload.github.com/msg-systems/componentDoc/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:07.911Z","updated_at":"2026-01-03T16:08:38.340Z","avatar_url":"https://github.com/msg-systems.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# componentDoc #\r\n\r\n[Node](https://nodejs.org/en/) API for execute the generation for a documentation of the source code of a Single Page Application. YAML-files - concrete component.yaml-files - are the input and HTML and if wanted PDF is the output.\r\n\r\nFor the PDF Creation the node module [node-prince](https://github.com/rse/node-prince) is used.\r\n\r\n## Motivation ##\r\n\r\nIf you use the [msg-js-spa-skeleton](https://github.com/msg-systems/msg-js-spa-skeleton) as the base of your Single Page Application one component exists out of the following fragments:\r\n\r\n- `component.yaml`  documentation of the component itself\r\n- `de.json` language property file - one for each language\r\n- `xxx-ctrl.js` source code for the controller\r\n- `xxx-model.js` source code for the model\r\n- `xxx-view.js` source code for the view\r\n- `xxx.less` styles for the component\r\n- `xxx.html` markup for the component\r\n\r\n**ComponentDoc** helps you to bundle the component.yaml-files of all components and preparing them in a nice and readable way.\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\r\n\r\n## Usage ##\r\n\r\n\r\n\t\tvar componentDoc = require(\"componentDoc\");\r\n\r\n\t\tcomponentDoc.generateDoc(files, \"bld\", {\r\n\t\t\toutputName: \"componentDoc\",\r\n    \t\ttemplate: \"template.hbs\",\r\n    \t\tbuildPDF: \"true\"\r\n\t\t}\r\n\r\n\r\n## Options ##\r\n\r\n- `outputFolder`  string - path and name of the folder for the generated documentation\r\n- `outputName`  string - name of the generated documentation (HTML and PDF)\r\n- `template`  string - path to the template, that should be used for the generation of the documatation\r\n\t\t\t [**default**: folder *'template'* and the partials under *'template/partials'*]\r\n- `buildPDF`  string - flag, if a PDF should be created as well\r\n- `caption` 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\r\n## See also ##\r\n\r\n\r\nThe command line interface for this node module [componentDoc-cli](https://github.com/msg-systems/componentDoc-cli).\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","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsg-systems%2Fcomponentdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsg-systems%2Fcomponentdoc/lists"}