dirgistered
a simple multi-platform directory indexer with html output.
available for:
![linux](https://raw.githubusercontent.com/yafp/dirgistered/master/.github/images/platform/linux_32x32.png)
![apple](https://raw.githubusercontent.com/yafp/dirgistered/master/.github/images/platform/apple_32x32.png)
![windows](https://raw.githubusercontent.com/yafp/dirgistered/master/.github/images/platform/windows_32x32.png)
![GitHub License](https://img.shields.io/github/license/yafp/dirgistered.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/85d982224c5c463098dc6eea410fcccf)](https://www.codacy.com/manual/yafp/dirgistered?utm_source=github.com&utm_medium=referral&utm_content=yafp/dirgistered&utm_campaign=Badge_Grade)
![npm audit](https://github.com/yafp/dirgistered/workflows/npm_audit/badge.svg)
![GitHub Current Release](https://img.shields.io/github/release/yafp/dirgistered.svg?style=flat)
![GitHub Release Date](https://img.shields.io/github/release-date/yafp/dirgistered.svg?style=flat)
[![jsDoc](https://github.com/yafp/dirgistered/workflows/jsdoc/badge.svg)](https://yafp.github.io/dirgistered/)
![ui](https://raw.githubusercontent.com/yafp/dirgistered/master/.github/images/screenshots/ui_latest.png)
**UI** (showing default state)
![ui](https://raw.githubusercontent.com/yafp/dirgistered/master/.github/images/screenshots/ui_latest_processing.png)
**UI** (while generating an index)
about
- scans a source directory
- generates a browseable html output in a target directory
download
You'll find the latest releases here.
license
Please see the LICENSE for more details.
changelog
Please see the changelog for more details.
support / fund
If you want to support the development of dirgistered you can fund me on:
developers
You are always welcome to check and even improve the code.
contributing
Please see the contributing informations for more details.
A list of all contributors can be found here.
jsdoc
The current jsdoc documentation can be found on https://yafp.github.io/dirgistered/. It is auto-generated (using JsDoc Action) on each commit of this project.
build
Building dirgistered yourself is pretty easy. Please see the building instructions for more details.
credits
icon