{"id":19839392,"url":"https://github.com/redislabs/mkdocs-versions-menu","last_synced_at":"2025-07-06T20:38:49.482Z","repository":{"id":89912843,"uuid":"247077968","full_name":"RedisLabs/mkdocs-versions-menu","owner":"RedisLabs","description":"An MkDocs plugin that generates a versions menu for the mkdocs-material theme.","archived":false,"fork":false,"pushed_at":"2023-10-10T19:48:45.000Z","size":21,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-16T13:04:52.226Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RedisLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-13T13:30:17.000Z","updated_at":"2020-08-04T12:27:03.000Z","dependencies_parsed_at":"2025-02-28T19:16:58.685Z","dependency_job_id":"f9417559-667f-4e23-b9c6-ca912f5f1c0b","html_url":"https://github.com/RedisLabs/mkdocs-versions-menu","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RedisLabs/mkdocs-versions-menu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Fmkdocs-versions-menu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Fmkdocs-versions-menu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Fmkdocs-versions-menu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Fmkdocs-versions-menu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RedisLabs","download_url":"https://codeload.github.com/RedisLabs/mkdocs-versions-menu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Fmkdocs-versions-menu/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263969557,"owners_count":23537448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T12:22:11.080Z","updated_at":"2025-07-06T20:38:49.453Z","avatar_url":"https://github.com/RedisLabs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-versions-menu\n\nThis MkDocs plugin generates a versions menu from the branches of a git repository. It is intended to be used with the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme.\n\nIt does the following when enabled in a docs repo:\n\n* It injects the required [theme](mkdocs_versions_menu/theme) files, but allows customization if these are provided by the docs\n* For the latest branch, it copies the docs to site/x.y\n* For other branches, it moves the docs to site/x.y\n* It generates supporting Javascript glue for tying it all together\n\nInspired by: https://github.com/containous/structor\n\n## Requirements\n\n* The [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme\n* A git docs repository\n\n## Setup\n\nInstall the plugin using pip:\n\n`pip install git+https://github.com/RedisLabs/mkdocs-versions-menu.git`\n\nActivate the plugin in `mkdocs.yml`:\n```yaml\nplugins:\n  - search\n  - versions-menu:\n      exclude-regexes:\n        - '(?!.*)'\n      include-regex: '([0-9]+)\\.([0-9]+)'\n      require-release-tag: yes\n      release-tag-regex: v([0-9]+)\\\\.([0-9]+)\\\\.([0-9]+)'\n      master-branch: 'master'\n      master-text: 'Master'\n      css-path: 'css'\n      javascript-path: 'javascript'\n```\n\n\u003e **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.\n\nMore information about plugins in the [MkDocs documentation](https://www.mkdocs.org/user-guide/plugins/).\n\n## Config\n\n* `exclude-regexes` - a list of branch regexes to exclude (default: ['(?!.*)'], i.e. nothing)\n* `include-regexes` - a string regex of branches to include, where `\\$1` is the major version and `\\$2` is the minor (default: '([0-9]+)\\.([0-9]+)')\n* `require-release-tag` - a boolean controlling whether included branches should have at least one tag (default: True)\n* `release-tag-regex` - a string regex for release tags (default: 'v([0-9]+)\\\\.([0-9]+)\\\\.([0-9]+)')\n* `master-branch` - a string name of the master branch, if set to '' then no master (default: 'master')\n* `master-text` - a string text to display for master branch (defaults to capitalized form of `master-branch`)\n* `css-path` - the site's css relative path (default: 'css')\n* `javascript-path` - the site's Javascript relative path (default: 'javascript')\n\n## Usage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredislabs%2Fmkdocs-versions-menu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredislabs%2Fmkdocs-versions-menu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredislabs%2Fmkdocs-versions-menu/lists"}