https://github.com/ohand/openhabconfigdocgen

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)
https://github.com/ohand/openhabconfigdocgen

Last synced: 5 days ago
JSON representation

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)

• Host: GitHub
• URL: https://github.com/ohand/openhabconfigdocgen
• Owner: ohAnd
• License: gpl-3.0
• Created: 2019-11-16T11:20:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-03-10T23:27:57.000Z (over 1 year ago)
• Last Synced: 2025-11-12T06:03:28.485Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 466 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# openhabConfigDocGen

![](https://github.com/ohAnd/openhabConfigDocGen/workflows/Node%20CI/badge.svg)

- [openhabConfigDocGen](#openhabconfigdocgen)

  - [Description](#description)

  - [Actual features](#actual-features)

  - [ToDo's](#todos)

  - [Screenshots](#screenshots)

    - [home screen](#home-screen)

    - [example for items in registry](#example-for-items-in-registry)

    - [example for items as file view](#example-for-items-as-file-view)

  - [Usage](#usage)

  - [Installation](#installation)

    - [Prerequisites](#prerequisites)

    - [Download & Install](#download-amp-install)

  - [Debugging](#debugging)

    - [execute with debugging on](#execute-with-debugging-on)

      - [Linux - OSX](#linux---osx)

      - [Windows CMD](#windows-cmd)

      - [Windows PowerShell](#windows-powershell)

  - [Testing](#testing)

## 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)

## Actual features

- basic html/ css/ js - template integrated for customization

- grab the given folder recursivly for known openhab config file formats

- show the folder/ file structure in the navigation tree with expand/ collpase

- show the content of each file on site with code highlighting

## ToDo's

- ~~highlighting for ESH Code~~

- searching the files for keywords

- cluster the hierarchy of rules, groups, items

- ...

## Screenshots

### home screen

base screen after generating the documentation

![home screen](./docu/home.gif "home screen")

### example for items in registry

the registry shows all groups and items as single objects, tooltip for further attributes

![example for items ](./docu/item_reg.png "example for an item file")

### example for items as file view

in the browser section the file contents can be reviewed

![example for items ](./docu/items.gif "example for an item file")

## Usage

to execute the generator start with the following command:

    node ohConfigDocGen.cli.js  

## Installation

### Prerequisites

This tool require node.js. To use it, install [NPM JS](https://www.npmjs.com/get-npm "get npm from www.npmjs.com")

### Download & Install

1. clone/ fetch the [master branch](https://github.com/ohAnd/openhabConfigDocGen.git)

2. navigate to downloded folder

3. in commandline

        

        npm install ..\\

    or

        

        npm install openhab_config_doc_gen

---

## Debugging

### execute with debugging on

#### Linux - OSX

    DEBUG=* node ohConfigDocGen.cli.js  

#### Windows CMD

    set DEBUG=* & node ohConfigDocGen.cli.js  

#### Windows PowerShell

    

    $env:DEBUG='*';node ohConfigDocGen.cli.js  

## Testing

 t.b.d.