Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sets current version in MkDocs configuration file #302

Merged

Conversation

froschdesign
Copy link
Member

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

Signed-off-by: Frank Brückner <dev@froschdesignstudio.de>
@froschdesign froschdesign added Bug Something isn't working Documentation labels May 11, 2024
@boesing boesing merged commit 6e5c74f into laminas:4.0.x May 11, 2024
11 checks passed
@boesing
Copy link
Member

boesing commented May 11, 2024

Thanks, @froschdesign

@froschdesign froschdesign deleted the hotfix/docs/missing-version-for-mkdocs branch May 11, 2024 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants