question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Links in tags index to tagged pages are incorrect on Windows

See original GitHub issue

Contribution guidelines

I’ve found a bug and checked that …

  • … the problem doesn’t occur with the mkdocs or readthedocs themes
  • … the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • … the documentation does not mention anything about my problem
  • … there are no open or closed issues that are related to my problem

Description

Adding support for tags in a subfolder in my documentation project did cause warnings at mkdocs serve. Additionally the tag links, from the tags.md inside subfolder, are not working and showing the 404 not found page.

Expected behaviour

Using tags.md in a subfolder should not cause warning as mkdocs serve building time & tag links should work.

Actual behaviour

Using tags.md in a subfolder cause warning & tag links do not work (404 not found)

(venv) PS C:\test\mkdocs test> mkdocs serve
INFO     -  Building documentation...
INFO     -  Cleaning site directory
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
WARNING  -  Documentation file 'getting-started\tags.md' contains a link to 'getting-started\getting-started\getting-started.md' which is not found in   
            the documentation files.
INFO     -  Documentation built in 0.22 seconds
INFO     -  [11:46:54] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [11:46:54] Serving on http://127.0.0.1:8000/
INFO     -  [11:47:07] Browser connected: http://127.0.0.1:8000/
INFO     -  [11:47:12] Browser connected: http://127.0.0.1:8000/getting-started/getting-started/
INFO     -  [11:47:14] Browser connected: http://127.0.0.1:8000/getting-started/tags/
WARNING  -  [11:47:16] "GET /getting-started/tags/getting-started/getting-started.md HTTP/1.1" code 404

Steps to reproduce

  1. Create a simple mkdocs.yml with tags and tags_file support (see below with the yml file I am using)
  2. Create the tags.md page in a ‘getting-started’ subfolder and reference in the mkdocs.yml
  3. Run mkdocs serve

Package versions

  • Python: python 3.9.7
  • MkDocs: mkdocs 1.3.0
  • Material: version 8.2.12

Configuration

site_name: 'Test Tags'
site_description: 'Description'
site_author: 'Company'

nav:
  - Home:
    - Introduction: index.md
    - Getting Started:
        - getting-started/getting-started.md
        - Tags: getting-started/tags.md

theme:
  name: 'material'

markdown_extensions:
  - meta

plugins:
  - search:
      prebuild_index: false
  - tags:
      tags_file: getting-started/tags.md

System information

  • Operating system: windows
  • Browser: Chrome

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:15 (8 by maintainers)

github_iconTop GitHub Comments

2reactions
schrurskcommented, May 1, 2022

Thank you for your swift investigation & solution. Even on a Sunday & holiday (labor day). Dedication I would say!

Thank you again.

0reactions
squidfunkcommented, May 2, 2022

Released as part of 8.2.13.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Search for tagged notes in OneNote - Microsoft Support
Search for tagged notes in OneNote · Click Home > Find Tags. Screenshot of the Find Tags button in OneNote 2016 · In...
Read more >
Canonical Tags: A Simple Guide for Beginners - Ahrefs
Canonical tags help to combat duplicate content issues. They tell search engines like Google to index and rank the right pages.
Read more >
Techniques for creating accessible links in PDFs for screen ...
Creating accessible links in PDFs is a basic accessibility requirement. This article looks at a selection of techniques for tagging links ...
Read more >
Edit document structure with the Content and Tags panels ...
Searches for artifacts, OCR suspects, and unmarked (untagged) content, comments, links, and annotations. Options allow you to search the page or ...
Read more >
Links - Usability & Web Accessibility - Yale University
In general, pages should have some non-color away of conveying links. This concern applies most to links that appear alongside or within blocks...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found