Giter VIP home page Giter VIP logo

miffels / mkdocs-git-revision-date-localized-plugin Goto Github PK

View Code? Open in Web Editor NEW

This project forked from timvink/mkdocs-git-revision-date-localized-plugin

0.0 1.0 0.0 1.28 MB

MkDocs plugin to add a last updated date to your site pages

Home Page: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html

License: MIT License

Python 98.10% CSS 0.75% JavaScript 1.15%

mkdocs-git-revision-date-localized-plugin's Introduction

Actions Status PyPI - Python Version PyPI PyPI - Downloads codecov GitHub contributors PyPI - License

mkdocs-git-revision-date-localized-plugin

MkDocs plugin that enables displaying the date of the last git modification of a page. The plugin uses babel and timeago.js to provide different localized date formats. Initial fork from mkdocs-git-revision-date-plugin.

demo

(Example when used together with the mkdocs-material theme)

Other MkDocs plugins that use information from git:

Setup

Install the plugin using pip3 with the following command:

pip3 install mkdocs-git-revision-date-localized-plugin

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - git-revision-date-localized

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.

If you use the mkdocs-material theme, you should already see the last revision on the bottom of your pages.

Note when using build environments

This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:

Change your CI settings
  • github actions: set fetch_depth to 0 (docs)
  • gitlab runners: set GIT_DEPTH to 0 (docs)
  • bitbucket pipelines: set clone: depth: full (docs)

Documentation

See timvink.github.io/mkdocs-git-revision-date-localized-plugin.

Contributing

Contributions are very welcome! Please read CONTRIBUTING.md before putting in any work.

mkdocs-git-revision-date-localized-plugin's People

Contributors

andreasbieber avatar biochimia avatar coliff avatar gu1ll0me avatar guts avatar oxr463 avatar pegasisforever avatar rdil avatar squidfunk avatar timvink avatar zhaoterryy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.