mkdocs / catalog

:trophy: :books: A list of awesome MkDocs projects and plugins.
Creative Commons Attribution Share Alike 4.0 International
1.12k stars 68 forks source link

Update project: Autolink References #233

Closed rhshadrach closed 4 months ago

rhshadrach commented 4 months ago

What kind of change does this PR introduce?

Description:

The package autolink-references-mkdocs-plugin is currently broken (see here) and I've not been able to get responses from the author. I've forked the project and implemented the fix.

This PR is adding my fork mkdocs-argref-plugin alongside the existing autolink-references-mkdocs-plugin.

Checklist:

pawamoy commented 4 months ago

Thanks, I'll try to review everything soon and get back to you :)

pawamoy commented 4 months ago

OK, everything looks good. However I'm not comfortable replacing the original plugin. Last commit was 7 months ago, sure, but that's not enough IMO to consider it unmaintained (even if there's an outstanding bug), especially given we have other projects listed here that have seen their last commit many years ago. Therefore, and if you don't mind, I'd prefer that you add your plugin to the list rather than replace the original one. WDYT :slightly_smiling_face:?

rhshadrach commented 4 months ago

Sounds good to me.

Last commit was 7 months ago, sure, but that's not enough IMO to consider it unmaintained (even if there's an outstanding bug),

I do want to stress that this isn't just "a bug". The bug makes the package almost entirely non-functional. Even worse, it will look like it's working for the first two references, but then will stop working on any more. Also that I've reached out to the maintainer in multiple ways.

But I understand the reservations on removing the package, will update this PR in the next day or two.

rhshadrach commented 4 months ago

@pawamoy - updated and green.