search

zachhannum / mkdocs-autolinks-plugin

An MkDocs plugin that automagically generates relative links between markdown pages
https://pypi.org/project/mkdocs-autolinks-plugin/
MIT License
80 stars 31 forks source link

Exclude files? #18

Closed SilentGlasses closed 2 years ago

SilentGlasses commented 3 years ago

Was just wondering if there is a way to add an exclude list to not try to link to files that would allow me to add this as an example of how to use the plugin:

[Page Name](page_name.md)
![Image](image.png)

but not get these warnings:

WARNING -  AutoLinksPlugin unable to find page_name.md in directory /git_repo/docs
WARNING -  AutoLinksPlugin unable to find image.png in directory /git_repo/docs

Was thinking in mkdocs.yml you can set something like this:

plugins:
  - search
  - autolinks:
      exclude:
        - page_name.md
        - image.png
Rwarcards762 commented 2 years ago

If the goal is to try and "show how to use the plugin" would wrapping the items in backticks not be sufficient, ie:

[Page Name](page_name.md)

or

[Page Name](page_name.md)

Ah nevermind -- it seems that is a current issue right now. Issue I think that is a blocking issue for this issue, as the correct "way" to showcase items in Markdown and its plugins should be escaping it with code fences / backticks. A resolution to it would solve this issue at the same time.

zachhannum commented 2 years ago

Yeah, the ideal solution would be to fix #1.

SilentGlasses commented 2 years ago

Solution is as @midnightprioriem said so closing this out to avoid duplication and confusion.