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.0.tar.gz (4.0 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.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs_techdocs_version_selector-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7b5ae240c8ed720cd595b65a8330143666044f8394b49de63dd3b534b6c40784
MD5 d630fdc5dfb0dcd8c18bd083c8a818cd
BLAKE2b-256 2a5a03caef43d7312de526247c91df35fba780c1c1e1e0c87807b089235597dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_techdocs_version_selector-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26859b83cca152f9acc7096bb7e2ed067e1e23071acae7b0fafc8891639a55d3
MD5 b1c0bd14dbe96e2189acb42a90999271
BLAKE2b-256 f16ff54123514082bb4195620f37fc7dbd8e8f7a03726ced58f4602d8cff93ed

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