search

laminas / laminas-cache

Caching implementation with a variety of storage options, as well as codified caching strategies for callbacks, classes, and output
https://docs.laminas.dev/laminas-cache/
BSD 3-Clause "New" or "Revised" License
103 stars 52 forks source link

Sets current version in MkDocs configuration file #302

Closed froschdesign closed 6 months ago

froschdesign commented 6 months ago

Versioned Contents

A documentation can be separated into different versions. Several steps are necessary for this.

Usage

  1. A separate subfolder is necessary for each version.
    • docs
      • book
      • v3
        • introduction.md
        • installation.md
        • …
      • v2
        • introduction.md
        • installation.md
        • …
      • index.md
  2. Extend the nav section of the MkDocs configuration file and a new section must be created for each version. Add the related navigation entries in these sections. 
    nav:
    - Home: index.md
    - v3:
        - Introduction: v3/introduction.md
        - Installation: v3/installation.md
        - …
    - v2:
        - Introduction: v2/introduction.md
        - Installation: v2/installation.md
        - …
  3. Extend the extra section of the MkDocs configuration file to add all available versions and the last / current version: 
    extra:
    current_version: v3
    versions:
        - v3
        - v2
boesing commented 6 months ago

Thanks, @froschdesign