docs-hub

Scans one or more root folders for .html/.md files that live under a docs/ or reports/ folder (at any depth), converts the Markdown ones to HTML, and builds a single browsable index grouped by top-level repo/folder. Runs locally on your own machine only — no hosting, no accounts, no data leaves your filesystem.

Install

pipx install .          # from this directory, or `pipx install docs-hub` once published
# or, in a venv:
pip install .

Quick start

docs-hub config set roots=/path/to/your/projects
docs-hub scan            # one-off run
docs-hub ui              # http://127.0.0.1:5000 — dashboard, settings, cron

The web UI lets you:

• Dashboard — see last scan info and open the generated index.
• Settings — pick which root folder(s) to scan, which folder names count as "docs"/"reports", and which directories to skip.
• Cron — see whether a scheduled scan is installed, and install/update/ remove it. This writes to your real user crontab, tagged with a # docs-hub-scan marker comment so it only ever touches its own job — your other cron jobs are left alone.

Config lives at ~/.config/docs-hub/config.json (or your platform's config-dir equivalent); generated output lives under ~/.local/share/docs-hub by default.

CLI reference

docs-hub scan [--root PATH ...]
docs-hub ui [--port 5000] [--host 127.0.0.1]
docs-hub config show
docs-hub config set KEY=VALUE [KEY=VALUE ...]   # comma-separate list values
docs-hub cron install [--schedule "0 * * * *"]
docs-hub cron remove
docs-hub cron status

Migrating from the old standalone generate.py

This repo previously shipped a single hardcoded script (generate.py) with a raw crontab entry pointing at it directly. To move to the packaged version:

pip install -e .                                    # from this directory
docs-hub config set roots=/home/arun/Arun/Projects   # restore the old scan target
docs-hub cron install --schedule "0 * * * *"         # replaces the raw crontab line
crontab -e                                           # remove the old raw generate.py line by hand

The old converted/, index.html, and cron.log produced by generate.py are independent of the new package's output directory and can be left in place or deleted once you've confirmed the new docs-hub scan output looks right. Note that docs-hub (this folder) itself sits under /home/arun/Arun/Projects, so it's included in the default exclude_dirs list to avoid the scanner picking up its own cached output as a phantom "repo".