# Documentation

This folder contains the detailed documentation for `excelminer`.

## Access after installation

List available docs:

```bash
python -m excelminer.docs --list
```

Print a document to stdout:

```bash
python -m excelminer.docs --show USAGE
```

Write all docs to a folder:

```bash
python -m excelminer.docs --write-dir .\excelminer-docs
```

Write the bundled HTML site to a folder (open the index.html locally):

```bash
python -m excelminer.docs --write-site .\excelminer-site
```

## Contents

- [Usage](USAGE.md)
- [Options](OPTIONS.md)
- [Backends](BACKENDS.md)
- [Output Schema](OUTPUT.md)
- [Security & Privacy](SECURITY.md)
- [Testing & Development](DEVELOPMENT.md)

## What excelminer does

`excelminer` extracts workbook artifacts (like sheets, defined names, connections, and formula text) into a normalized in-memory graph. The graph is designed to be serialized deterministically to JSON for downstream analysis.

If you just want the quickest path, start with [Usage](USAGE.md).
