Blog related links with Attachments usable

[strausmann]

Contribution guidelines

• I've read the contribution guidelines and wholeheartedly agree

I want to suggest an idea and checked that ...

• ... to my best knowledge, my idea wouldn't break something for other users
• ... the documentation does not mention anything about my idea
• ... there are no open or closed issues that are related to my idea

Description

Currently it seems that only external links and .md files can be linked to in Related Links. We would also be able to provide e.g. PDF, Word or other files via the Related Links.

Use Cases

In the blog, it would be generally useful to place attached documents present by means of the Related Links. In texts with sometimes 5-6 A4 pages, the links to attachments would simply get lost.

We have already tried to link the attachments in the documents, then to link them via the assets URI in the Related Links. But this is quite complicated.

Screenshots / Mockups

No response

[squidfunk]

Thanks for suggesting. Please provide some more information of how you imagine to use this feature. External, fully-qualified links should already work. Otherwise we need to know what configuration you're using.

A self-contained example would be great.

[strausmann]

We use MkDocs Material Insider for an internal system for Company Information.

The posts are called Circulars and can have attachments. These attachments can be linked in the blog area of MkDocs Material currently only in the content of the post.

With Related Links we cannot link the documents, here only external links or other pages from MkDocs are possible.

So we have the following requirement. In a blog post files like PDF, Word, Excel etc. should be linked. Files can be included via the Related Links. The attachments are located in the project directly next to the post file (*.md) itself.

[strausmann]

Ahso, because with an attachment probably no meaningful name for the Related Link is possible. Currently there would always be "None". Would be a similar integration as required for external links.

[squidfunk]

I'm not sure what you're doing, but I can't reproduce the problem – linking files works perfectly for me. For example, take the following configuration:

links:
  - setup/setting-up-site-search.md#built-in-search-plugin
  - insiders/index.md#how-to-become-a-sponsor
  - PDF: blog/posts/test.pdf

Results in:

Clicking on the PDF opens it. I suspect that the path is wrong – the path must start at the root of your docs_dir.

[squidfunk]

Okay, so the case where you don't specify the title for the PDF doesn't work correctly. That wasn't apparent for me from what you wrote. I'll reopen the issue and investigate.

[squidfunk]

Fixed in squidfunk/mkdocs-material-insiders@606c88cc3. Non-Markdown links now correctly resolve to the assets destination paths after copying. Additionally, it no title is set, the filename is used.

[squidfunk]

Released as part of 8.5.10+insiders-4.26.3.

[strausmann]

Thank you