MkDocs plugin that builds TechDocs versions from catalog-info.yaml
Project description
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(techdocsVersionsby default) - Builds the current docs as usual
- Builds each configured version into a dedicated subdirectory (for example
__v2,__v3) - Writes a
multiversion.jsonmanifest that can be consumed by a version selector UI
Installation
pip install mkdocs-techdocs-version-selector
Configuration
In your mkdocs.yml:
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):
metadata:
techdocsVersions:
- latest: main
- v2: v2
- v1: v1
Requirements
- Python 3.9+
mkdocsPyYAMLgitavailable onPATHtechdocs-cliavailable onPATH
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_techdocs_version_selector-0.1.1.tar.gz.
File metadata
- Download URL: mkdocs_techdocs_version_selector-0.1.1.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f635608de3e1d7b9f0015aae3be8f722c95929ccc7808c4d404b1eacb3590688
|
|
| MD5 |
8e468d06fb156edca9a5f173597c128c
|
|
| BLAKE2b-256 |
1f22599b6b44fc3e014b75e193abfa145338d94d438f385538f818cedea9b49e
|
File details
Details for the file mkdocs_techdocs_version_selector-0.1.1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_techdocs_version_selector-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e89be5d0e22697d14ff0310451fedefabac56cba25743787adb3c294b6ae07c4
|
|
| MD5 |
ae95214ab87f63e29558e42b65d5ac1d
|
|
| BLAKE2b-256 |
2ce68435b3c57e2dfae7aa010a61dc45ad149dfb07c488565ef62c3954857157
|