{"id":19055902,"url":"https://github.com/ohand/openhabconfigdocgen","last_synced_at":"2026-06-17T06:32:18.445Z","repository":{"id":36821430,"uuid":"222088391","full_name":"ohAnd/openhabConfigDocGen","owner":"ohAnd","description":"A tool to generate a good looking browserable overview for your own openhab configuration. In the first step only for the data in config files. Planned for future, to get all information of the database of openhab too. (e.g. thing configuration)","archived":false,"fork":false,"pushed_at":"2025-03-10T23:27:57.000Z","size":477,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-12T06:03:28.485Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ohAnd.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":"2019-11-16T11:20:59.000Z","updated_at":"2023-03-03T20:05:36.000Z","dependencies_parsed_at":"2025-01-02T11:25:39.420Z","dependency_job_id":"f4fb115b-31a6-4b74-9530-c257d4ddc402","html_url":"https://github.com/ohAnd/openhabConfigDocGen","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ohAnd/openhabConfigDocGen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ohAnd%2FopenhabConfigDocGen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ohAnd%2FopenhabConfigDocGen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ohAnd%2FopenhabConfigDocGen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ohAnd%2FopenhabConfigDocGen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ohAnd","download_url":"https://codeload.github.com/ohAnd/openhabConfigDocGen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ohAnd%2FopenhabConfigDocGen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34437449,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-17T02:00:05.408Z","response_time":127,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-08T23:47:22.467Z","updated_at":"2026-06-17T06:32:18.421Z","avatar_url":"https://github.com/ohAnd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openhabConfigDocGen\n\n![](https://github.com/ohAnd/openhabConfigDocGen/workflows/Node%20CI/badge.svg)\n\n- [openhabConfigDocGen](#openhabconfigdocgen)\n  - [Description](#description)\n  - [Actual features](#actual-features)\n  - [ToDo's](#todos)\n  - [Screenshots](#screenshots)\n    - [home screen](#home-screen)\n    - [example for items in registry](#example-for-items-in-registry)\n    - [example for items as file view](#example-for-items-as-file-view)\n  - [Usage](#usage)\n  - [Installation](#installation)\n    - [Prerequisites](#prerequisites)\n    - [Download \u0026amp; Install](#download-amp-install)\n  - [Debugging](#debugging)\n    - [execute with debugging on](#execute-with-debugging-on)\n      - [Linux - OSX](#linux---osx)\n      - [Windows CMD](#windows-cmd)\n      - [Windows PowerShell](#windows-powershell)\n  - [Testing](#testing)\n\n## Description\n\nA tool to generate a good looking browserable overview for your own openhab configuration.\nIn the first step only for the data in config files. Planned for future, to get all information of the database of openhab too. (e.g. thing configuration)\n\n## Actual features\n- basic html/ css/ js - template integrated for customization\n- grab the given folder recursivly for known openhab config file formats\n- show the folder/ file structure in the navigation tree with expand/ collpase\n- show the content of each file on site with code highlighting\n\n## ToDo's\n- ~~highlighting for ESH Code~~\n- searching the files for keywords\n- cluster the hierarchy of rules, groups, items\n- ...\n\n## Screenshots\n\n### home screen\nbase screen after generating the documentation\n\n![home screen](./docu/home.gif \"home screen\")\n\n### example for items in registry\nthe registry shows all groups and items as single objects, tooltip for further attributes\n\n![example for items ](./docu/item_reg.png \"example for an item file\")\n\n### example for items as file view\n\nin the browser section the file contents can be reviewed\n\n![example for items ](./docu/items.gif \"example for an item file\")\n\n## Usage\n\nto execute the generator start with the following command:\n\n    node ohConfigDocGen.cli.js \u003csrcfolder_of_openhab_config\u003e \u003ctargetfolder_for_output\u003e\n\n## Installation\n\n### Prerequisites\n\nThis tool require node.js. To use it, install [NPM JS](https://www.npmjs.com/get-npm \"get npm from www.npmjs.com\")\n\n### Download \u0026 Install\n\n1. clone/ fetch the [master branch](https://github.com/ohAnd/openhabConfigDocGen.git)\n2. navigate to downloded folder\n3. in commandline\n        \n        npm install ..\\\u003cyourdownloadfolder\u003e\\\n    or\n        \n        npm install openhab_config_doc_gen\n\n---\n\n## Debugging\n\n### execute with debugging on\n\n\n#### Linux - OSX\n\n    DEBUG=* node ohConfigDocGen.cli.js \u003csrcfolder_of_openhab_config\u003e \u003ctargetfolder_for_output\u003e\n\n#### Windows CMD\n\n    set DEBUG=* \u0026 node ohConfigDocGen.cli.js \u003csrcfolder_of_openhab_config\u003e \u003ctargetfolder_for_output\u003e\n#### Windows PowerShell\n    \n    $env:DEBUG='*';node ohConfigDocGen.cli.js \u003csrcfolder_of_openhab_config\u003e \u003ctargetfolder_for_output\u003e\n\n## Testing\n t.b.d.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fohand%2Fopenhabconfigdocgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fohand%2Fopenhabconfigdocgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fohand%2Fopenhabconfigdocgen/lists"}