Suppress warning when links do not include the .md extension

[tadashi-aikawa]

Thank you for this amazing plugin!

I often build documentation sites using MkDocs, but after a while, the redundancy of Markdown links starts to feel cumbersome. Most of the time, I find myself wanting to build sites using wiki-style links, like in Obsidian. That's why I really want to use this plugin, as it provides a minimal bridge simply by adding it as an MkDocs plugin.

After using it for a while, I noticed one thing that concerns me. When pageLink.md exists, creating a link like [[pageLink]] always results in a warning in the output of the mkdocs serve command.

WARNING -  [ObsidianBridgePlugin] Unable to find pageLink in directory /home/tadashi-aikawa/tmp/mkdocs-sandbox/docs

After checking the source code, I found that find_best_path is executed with the specified path as is, which always results in a warning.

    def replace_obsidian_link(self, page_path: Path, match: re.Match) -> str:
        assert page_path.is_absolute()

        whole_match: str = match[0]
        matched_filepath: str = match['filepath'].strip()

        if matched_filepath == '':
            return f'''[{
                match['label'] or match['fragment_text'] or ''
            }]({
                self.slugify(match['fragment'])
            })'''
        else:
            link_filepath = Path(matched_filepath.replace('\\', '/'))

            # 📝 `[[pageLink]]` always returns the warning message
            new_path = self.find_best_path(link_filepath, page_path)
            # if nothing found, try once again but with ".md" file extension
            if new_path is None:
                new_suffix = link_filepath.suffix + '.md'
                new_path = self.find_best_path(link_filepath.with_suffix(new_suffix), page_path)

In my use case, I don't include file extensions in wiki links, just like in Obsidian. As a result, a warning is displayed for every wiki link, which may cause important warning messages to be overlooked. To avoid this, I have applied the following change.

- new_path = self.find_best_path(link_filepath, page_path)
+ if any([link_filepath.name.endswith("." + fmt) for fmt in self.OBSIDIAN_FORMATS]):
+     new_path = self.find_best_path(link_filepath, page_path)
+ else:
- # if nothing found, try once again but with ".md" file extension
- if new_path is None:
+     # if nothing found, try once again but with ".md" file extension
      new_suffix = link_filepath.suffix + '.md'
      new_path = self.find_best_path(link_filepath.with_suffix(new_suffix), page_path)

I don't necessarily think this approach will be beneficial for everyone, and I'm not sure if this workaround is the best solution. However, I would be happy if there were a way to control warnings like this, including the option to configure it.

Thank you!

[GooRoo]

Thanks a lot for the feedback!

Honestly, I feel like logging in the plugin requires some update for a while. I added it in the very beginning but then after all the later changes I didn't really tried to improve it or even to re-evaluate whether it is still correct and makes sense.

I'll spend some time refactoring it to hopefully make it better.

[GooRoo]

@tadashi-aikawa Please, try the latest version. Should be better now.

[tadashi-aikawa]

@GooRoo
Sorry for the late reply. Thank you for addressing this!

I'll likely try the new version and provide feedback sometime in September.

[GooRoo]

@tadashi-aikawa Please, don't hesitate to create an issue or start a new discussion if something goes wrong.