Skip to content

MkDocs plugin for showing a history log for a specified markdown file

License

Notifications You must be signed in to change notification settings

pawelsikora/mkdocs-git-show-history-log-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

mkdocs-git-show-history-log-plugin

MkDocs plugin that displays the history log table for a specified markdown file, based on last N number of git commits as follows:

Version Author When Message
0.1 Your Name 2020-10-18, 07:05:08 Your Message

Setup

Install the plugin using pip:

pip install mkdocs-git-show-history-log-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - git-show-history-log

More information about plugins in the [MkDocs documentation][mkdocs-plugins].

Usage

Markdown - {{ git_show_history_log }}:

Example

**Changelog:**

{{ git_show_history_log }}

Options

max_number_of_commits

Setting this option will specify maximum number of commits(rows) per history log for the file. Default is set to 5.

About

MkDocs plugin for showing a history log for a specified markdown file

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages