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

MkDocs plugin for showing a history log for a specified markdown file
MIT License
3 stars 2 forks source link

Is this project maintained/usable in production? #1

Closed julienbeisel closed 2 years ago

julienbeisel commented 2 years ago

Hi @pawelsikora

You made a plugin that fits perfectly my needs! I'd like to use it for one of my company's projects. Is it usable in production? I see very few activity on this repo.

Thanks :)

pawelsikora commented 2 years ago

Hi @julienbeisel,

Sorry for last comment, I thought it was about a different plugin :(

In general, I would say it is maintained but not actively, as I was not using it so much and had not so much feedback about it.

Usable in production? Well, it depends - you should try for yourself in dev env first and decide :)

I was using it in my last company's project and it was just working fine, so actually I am eager to hear from you it it is working for you as you expect or you have some comments for improvements/fixes!

Ah, and what should be noted and I forgot to add in the Readme: you can specify number of commits you want to display in a table by:

Kind Regards, Pawel

julienbeisel commented 2 years ago

It works perfectly !

I used this plugin before: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin I like how easy git-revision-date-localized : you just add the plugin on your doc & it displays the last commit date on every file.

I think that adding "{{git_show_history_log }}" at the end of our markdown files (> 300) won't be possible for us. Do you think it can be enabled by default for every file? I tried to use an override in mkdocs-material without success.

Thanks :)

pawelsikora commented 2 years ago

@julienbeisel I think it should be possible without any problems. Could you open separate Issue according to what you want? and I will open merge request so you will be able to test it locally on your side

pawelsikora commented 2 years ago

It is just quick patch for you:

https://github.com/pawelsikora/mkdocs-git-show-history-log-plugin/tree/dev_0.0.1

Could you please install this version locally and check?

I would need to do it a bit differently in case we would like to merge it to main and push new package.

P.S. just remember to uninstall 0.1, as I did on purpose did set version to 0.0.1 in local setup.py.

julienbeisel commented 2 years ago

Thanks Pawel

I will try that! I'll let you know

julienbeisel commented 2 years ago

It's perfect! Thanks

I'm going to edit the way it's rendered (table headers, date format). Do you want me to send issues once I've done that so we can improve the plugin? I can also send you PRs with more config options

pawelsikora commented 2 years ago

@julienbeisel

Nice to hear that, I have not checked that even, yay! :D

Sure, please send Issue and we will talk in PRs about other features :)