root-relative links and github-pages

[madeinoz67]

In my docs I'm creating all internal links as root-relative, e.g. a link form one page to something else as e.g. [link](/topic) however when published to GitHub pages these links can't be found as per how git-hub pages adds the project name into path of the URL. e.g. https://username.github.io/project/topic

Whats the best way of handling root-relative links in mkdocs-materials?

Cheers

[squidfunk]

Have you defined site_url? You should set site_url to the root path of your documentation project:

mkdocs-material/mkdocs.yml

Line 23 in ff53ba0

site_url: https://squidfunk.github.io/mkdocs-material/

If that doesn't work, there might be some plugins that help to transform root-relative links prior to the build. Another idea is to use the macros plugin: mkdocs/mkdocs#192 (comment)

[madeinoz67]

Thanks for that, I added site_url and didnt make any differnce, in the end what worked for me is to use the ezlinks plugin https://github.com/orbikm/mkdocs-ezlinks-plugin, while not root-relative links it was good enough for what I wanted.