Metadata-Version: 2.4
Name: mkdocs-techdocs-version-selector
Version: 0.1.0
Summary: MkDocs plugin that builds TechDocs versions from catalog-info.yaml
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: MkDocs
Classifier: Topic :: Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: mkdocs>=1.5
Requires-Dist: PyYAML>=6.0

# mkdocs-techdocs-version-selector

MkDocs plugin that builds versioned TechDocs static sites from a `catalog-info.yaml` versions list.

## What it does

- Reads versions from `catalog-info.yaml` (`techdocsVersions` by default)
- Builds the current docs as usual
- Builds each configured version into a dedicated subdirectory (for example `__v2`, `__v3`)
- Writes a `multiversion.json` manifest that can be consumed by a version selector UI

## Installation

```bash
pip install mkdocs-techdocs-version-selector
```

## Configuration

In your `mkdocs.yml`:

```yaml
plugins:
  - techdocs-version-selector:
      catalog_info_path: catalog-info.yaml
      versions_key: techdocsVersions
      site_subdir_prefix: "__"
      manifest_filename: multiversion.json
```

In your `catalog-info.yaml`, add a versions list (newest first):

```yaml
metadata:
  techdocsVersions:
    - latest: main
    - v2: v2
    - v1: v1
```

## Requirements

- Python 3.9+
- `mkdocs`
- `PyYAML`
- `git` available on `PATH`
- `techdocs-cli` available on `PATH`
