Skip to content

Navigation support bugfix #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lovelydinosaur merged 2 commits into from
Sep 11, 2026
Merged

Navigation support bugfix #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2240f58
Navigation support bugfix
lovelydinosaur Sep 11, 2026
ff56807
Update changelog
lovelydinosaur Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
## 2.0.dev5

**Navigation Support Bugfix**

Use relative URLs for site navigation. Ensures that sites hosted on a subpath still link correctly. [#54](https://github.com/encode/mkdocs/pull/54)

## 2.0.dev4

**Navigation Support**

Preliminary support for site navigation.

See [#49](https://github.com/encode/mkdocs/pull/49) for further details.
Preliminary support for site navigation. [#49](https://github.com/encode/mkdocs/pull/49)
2 changes: 1 addition & 1 deletion docs/templates/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</head>
<body>
<nav class="site">
{{ nav.html }}
{% include "navigation.html" %}
</nav>
<nav class="toc">
{{ page.toc.html }}
Expand Down
3 changes: 3 additions & 0 deletions docs/templates/navigation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<ul>
{% for item in nav %}<li><a href="{{ item.page.url | url }}"{% if item.page.url == page.url %} class="active"{% endif %}>{{ item.title }}</a></li>{% endfor %}
</ul>
2 changes: 1 addition & 1 deletion src/mkdocs/__version__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__title__ = "mkdocs"
__version__ = "2.0.dev4"
__version__ = "2.0.dev5"
4 changes: 1 addition & 3 deletions src/mkdocs/extensions/relative_urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ def run(self, root):

url_from = page.url
url_to = target.url
rewrite = posixpath.relpath(url_to, url_from)
if url_to.endswith('/') and rewrite != '.':
rewrite += '/'
rewrite = mkdocs.link_to(url_from, url_to)
if url.query:
rewrite += f'?{url.query}'
if url.fragment:
Expand Down
15 changes: 13 additions & 2 deletions src/mkdocs/mkdocs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ def get_site():
return ctx


def link_to(path_from, path_to):
if path_from == path_to:
return '.'
p0 = path_from.split('/')
p1 = path_to.split('/')
for idx, pair in enumerate(zip(p0, p1)):
if pair[0] != pair[1]:
break
p = ['..' for i in p0[idx+1:]] + p1[idx:]
return '/'.join(p)


class Page:
def __init__(self, path):
self.path = path
Expand Down Expand Up @@ -194,8 +206,7 @@ def init_env(self, input_dir) -> jinja2.Environment:
@jinja2.pass_context
def url(ctx, url_to):
url_from = ctx['page'].url
url_rel = posixpath.relpath(url_to, url_from) # This isn't correct
return url_rel
return link_to(url_from, url_to)

dir = pathlib.Path(input_dir)
loader = jinja2.ChoiceLoader([
Expand Down
Loading