# Make Markdown Library

Make Markdown Library turns messy folders, files, and ZIP archives into reproducible AI-readable Markdown libraries with manifests, JSON/YAML indexes, optional split Markdown files, and MarkItDown/LiteParse converter routing.

Public documentation: https://markbeachill.github.io/make-markdown-library/
GitHub repository: https://github.com/markbeachill/make-markdown-library
Releases: https://github.com/markbeachill/make-markdown-library/releases
Installer package: https://github.com/markbeachill/make-markdown-library/releases/download/v0.4.0/make_markdown_library-0.4.0-py3-none-any.whl
Online viewer: https://markbeachill.github.io/make-markdown-library/viewer/
Standalone viewer: https://markbeachill.github.io/make-markdown-library/view-markdown-library.html

## User installation

Normal users install the release wheel package with Python pip. They do not need to download, unzip, or keep the GitHub source repository.

Windows install guide:
https://markbeachill.github.io/make-markdown-library/guides/windows-install/

Install Python on Windows:
https://markbeachill.github.io/make-markdown-library/guides/install-python-windows/

Uninstall guide:
https://markbeachill.github.io/make-markdown-library/guides/uninstall/

Windows prerequisites:
https://markbeachill.github.io/make-markdown-library/guides/windows-prerequisites/

## Key commands

Check the installed tool:

```powershell
py -m make_markdown_library --version
```

Build a library:

```powershell
py -m make_markdown_library make "C:\Users\Mark\Documents\My Project" --converter auto
```

Run diagnostics:

```powershell
py -m make_markdown_library doctor
```

Uninstall:

```powershell
py -m pip uninstall make-markdown-library
```

## Important docs

- Getting started: /getting-started/
- Processing rules: /processing-rules/
- CLI reference: /cli-reference/
- Output reference: /output-reference/
- Markdown Library Viewer: /guides/markdown-library-viewer/
- Converter modes: /guides/converter-modes/
- Markdown folders: /guides/markdown-folders/
- OCR, PDFs, and images: /guides/ocr-and-pdfs/

## Behaviour contract

The tool classifies each scanned item as a source document, existing Markdown, generated output, existing library, ZIP container, duplicate, or unsupported. Generated manifests, indexes, and split outputs are skipped by default. Existing outputs are protected by default unless overwrite or backup options are explicit.