Absolute url vs relative url

[svrooij]

Describe the bug

The menu items have the | absolute_url instruction after the url. This makes them (you guessed it) absolute. For this to work you also need to set the url in the config file. Since jekyll is perfectly capable of generating the correct urls, I would hope for a way to disable the absolute url part (config) or to completely remove it.

Apparently this also exists in the table of content with child pages.

https://github.com/pmarsceill/just-the-docs/blob/e8424986370bef104e680e1443a83e475d2fead7/_includes/nav.html#L67

To Reproduce

Publish any website with just-the-docs.

Expected behavior

I would expect that the url would just be relative. That means that if I want to publish it to a different domain (eg. netlify) the links in the menu would still work. Without me needing to change url.

Screenshots

Additional context

At this page the menu links are absolute while the links in the page are relative (and just work).

[pdmosses]

@svrooij thanks for the bug report and PR #544.

In fact this issue should have been fixed in v0.3.2: the release notes refer to #359, which replaced absolute_url by relative_url in _includes/head.html, _includes/nav.html, and lib/tasks/search.rake. However, it appears that the changes to _includes/nav.html in PR #411 conflicted with those in #359, and I must have overlooked that when #411 was merged into v0.3.2.

[svrooij]

I saw the v0.3.2 release notes, then spend some time getting it to work. Failed horrible. Than checked the code in master and found that it still had a lot of absolute_url.

The PR replaces them once more.

[ygd]

@svrooij thank you for this

[svrooij]

Until it is fixed in this repo, you can use remote_theme: svrooij/just-the-docs@relative-everything in your _config.yml like I do here:

https://github.com/svrooij/node-sonos-ts/blob/27c49b6249c5f0cf2fca17d03f10508f62c604f1/docs/_config.yml#L30

[ygd]

Until it is fixed in this repo, you can use remote_theme: svrooij/just-the-docs@relative-everything in your _config.yml like I do here:

https://github.com/svrooij/node-sonos-ts/blob/27c49b6249c5f0cf2fca17d03f10508f62c604f1/docs/_config.yml#L30

or just overwrite the files locally ...

[svrooij]

Locally overriding the files works great, but I found one part that I couldn't override (I think it was the side menu). That is why I also forked the repo with a solution that works without any big changes to your project.

[MichaelCurrin]

Thanks! I came here looking for this issue and found, as the absolute URLs are surprising when navigating on a local site.

I approved #544

[pdmosses]

This issue should (finally) be fixed in v0.4.0.rc1.