{"id":21576,"library":"mkdocs-git-committers-plugin-2","title":"mkdocs-git-committers-plugin-2","description":"An MkDocs plugin to create a list of contributors on the page. The plugin seeds the template context with a list of GitHub or GitLab committers and other useful GIT info such as last modified date. Current version is 2.5.0, with regular releases.","status":"active","version":"2.5.0","language":"python","source_language":"en","source_url":"https://github.com/ojacques/mkdocs-git-committers-plugin-2","tags":["mkdocs-plugin","contributors","git","github","gitlab"],"install":[{"cmd":"pip install mkdocs-git-committers-plugin-2","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"This is an MkDocs plugin","package":"mkdocs","optional":false},{"reason":"Used for API calls to GitHub/GitLab","package":"requests","optional":false},{"reason":"Used for local git operations like last commit date","package":"gitpython","optional":false}],"imports":[],"quickstart":{"code":"# In mkdocs.yml:\n# plugins:\n#   - git-committers:\n#       repository: owner/repo\n#       branch: main\n#       token: !!python/name:os.environ.get('GH_TOKEN','')","lang":"yaml","description":"Add the plugin to your MkDocs config. The 'repository' field is required, and a token is recommended for GitHub to avoid rate limiting."},"warnings":[{"fix":"Set an environment variable (e.g. GH_TOKEN or GITLAB_TOKEN) and reference it in mkdocs.yml via !ENV or !!python/name.","message":"The plugin requires an API token for GitLab in all cases; for GitHub, unauthenticated requests are allowed but rate-limited to 60 calls/hour. You must provide a token for private repos or higher rate limits.","severity":"gotcha","affected_versions":">=2.1.0"},{"fix":"No code change required; the plugin automatically uses REST API. Ensure your token has appropriate REST API permissions.","message":"From version 2.1.0, the plugin switched from GraphQL API back to REST API for both GitHub and GitLab. This may affect users who were relying on GraphQL-specific behavior.","severity":"breaking","affected_versions":">=2.1.0"},{"fix":"Remove 'docs_path' from your mkdocs.yml.","message":"The configuration option 'docs_path' is deprecated; the plugin now automatically searches parent directories for the Git repository.","severity":"deprecated","affected_versions":">=2.2.3"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Add 'api_version: v3' (for GitHub) or 'api_version: v4' (for GitLab) to your mkdocs.yml under the plugin settings.","cause":"Missing 'api_version' config option when using self-hosted GitHub/GitLab","error":"KeyError: 'api_version'"},{"fix":"Upgrade to version 2.4.1 or later.","cause":"Bug in version 2.4.0 when using GitHub or GitLab without proper token/rate limit handling","error":"UnboundLocalError: local variable 'user' referenced before assignment"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}