Thanks a lot for the PR @AlphaBs!

Don't we always want to output absolute links? Is the option really useful here, if the "backward-compatible" behavior is actually a bug?

Also, I'm not sure to understand the purpose of the index_file_name option. Aren't index files always named index.md?

Thanks for the feedback!

• For my use case, I always need absolute links. However, I set the default to false because I wasn't sure about other users' needs, even though I personally believe the default should be true. I'm happy to go with your opinion on this. I've never personally needed relative links, so I can't judge if the previous behavior was a required feature for someone else.

• I created the index_file_name option because I wasn't completely sure how mkdocs works internally. I added it just in case there was a configuration in mkdocs that might change the output filename (e.g., from README.md to something other than index.md). If mkdocs always converts README.md to index.md, then you are correct, and this option is unnecessary.

Let's go with always rendering absolute links then!

I created the index_file_name option because I wasn't completely sure how mkdocs works internally. I added it just in case there was a configuration in mkdocs that might change the output filename (e.g., from README.md to something other than index.md). If mkdocs always converts README.md to index.md, then you are correct, and this option is unnecessary.

I see where you come from. MkDocs will consider README.md to be an index page, but this index page will always be named index.html. From there, the equivalent Markdown page we build will always be named index.md. Well, I think. Let me check.

Yeah that's probably it:

path_md = Path(page.file.abs_dest_path).with_suffix(".md")

The absolute destination path would definitely be index.html even if the page is named readme.md.

So, you can remove both options and update the code accordingly 🙂

Thanks for the super fast answer!

Thanks for clarifying! I'll remove the absolute_link and index_file_name option and update the code to always generate absolute links right now.

Updated! Let me know if there's anything else you'd like me to change.

Did you use AI by the way? Just curious.

Did you use AI by the way? Just curious.

I used AI for writing the comments and the PR message, as I'm not a native English speaker. I wrote the code logic myself.

What do you think about separating the relative path conversion logic from plugin.py?
Currently, we're testing this logic within test_plugin.py, and it seems to make debugging difficult when tests fail, and the test code is becoming overly complicated.
We could thoroughly test the conversion logic in its own test_converter.py and leave only the very basic integration cases in test_plugin.py.