ojacquesojacques
69

Mkdocs Git Committers Plugin 2

screenshot of Mkdocs Git Committers Plugin 2
mkdocs

MkDocs plugin for displaying a list of GitHub (.com or Enterprise) contributors on each page. Encourages contributions to the documentation!

Github

Overview

The mkdocs-git-committers-plugin-2 is an innovative tool for developers seeking to seamlessly display a list of committers associated with files in MkDocs documentation. Leveraging the GitHub or GitLab API, this plugin provides a convenient way to showcase contributors for each page, enhancing collaboration visibility in your projects. Its integration with the Material for MkDocs theme makes it a user-friendly choice for those already familiar with this setup.

The latest version of the plugin has added support for GitLab, broadening its usability. With straightforward setup instructions and options for obtaining contributor data from both local Git repositories and REST APIs, this plugin is designed to meet the needs of diverse development environments.

Features

  • GitHub and GitLab Support: Fetch contributor lists from both GitHub and GitLab repositories, making it versatile for varying workflow preferences.
  • Easy Installation: Install the plugin effortlessly using pip, ensuring a quick start to enhance your MkDocs projects.
  • Configurable Settings: Customize your usage with parameters such as repository name, branch, and personal access tokens tailored to your needs.
  • Automatic Update of Contributors: Automatically counts and displays commit authors, committers, and co-authors for GitHub, providing clarity on contributions.
  • Warning Notifications: Alerts you if co-authors exist but the necessary token isn’t provided, ensuring awareness of potential missing data.
  • Local Build Compatibility: Option to disable the plugin during local builds while maintaining functionality for deployed documentation.
  • Enhanced Rate Limits: By using personal access tokens, users can increase their API request limits beyond standard rates for improved efficiency.
  • Focused Access Control: Create specific access tokens for GitLab to limit the scope to your project, enhancing security and management.
mkdocs
MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.