Skip to main content

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 (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

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+
  • mkdocs
  • PyYAML
  • git available on PATH
  • techdocs-cli available on PATH

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

mkdocs_techdocs_version_selector-0.1.1.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file mkdocs_techdocs_version_selector-0.1.1.tar.gz.

File metadata

File hashes

Hashes for mkdocs_techdocs_version_selector-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f635608de3e1d7b9f0015aae3be8f722c95929ccc7808c4d404b1eacb3590688
MD5 8e468d06fb156edca9a5f173597c128c
BLAKE2b-256 1f22599b6b44fc3e014b75e193abfa145338d94d438f385538f818cedea9b49e

See more details on using hashes here.

File details

Details for the file mkdocs_techdocs_version_selector-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_techdocs_version_selector-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e89be5d0e22697d14ff0310451fedefabac56cba25743787adb3c294b6ae07c4
MD5 ae95214ab87f63e29558e42b65d5ac1d
BLAKE2b-256 2ce68435b3c57e2dfae7aa010a61dc45ad149dfb07c488565ef62c3954857157

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page