From 32d2ed3bee82c58470a9b87a9bd2e886b5a4e1ee Mon Sep 17 00:00:00 2001 From: devakker Date: Thu, 7 Mar 2019 15:52:08 +0100 Subject: [PATCH] Add warning to docs about usage of absolute paths in links. Fixes #1757. --- docs/user-guide/writing-your-docs.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/user-guide/writing-your-docs.md b/docs/user-guide/writing-your-docs.md index d6f90cd7..d4f047d3 100644 --- a/docs/user-guide/writing-your-docs.md +++ b/docs/user-guide/writing-your-docs.md @@ -201,6 +201,13 @@ Please see the [project license](license.md) for further details. When the MkDocs build runs, these Markdown links will automatically be transformed into an HTML hyperlink to the appropriate HTML page. +!!! warning + Using absolute paths with links is not officially supported. Relative paths + are adjusted by MkDocs to ensure they are always relative to the page. Absolute + paths are not modified at all. This means that your links using absolute paths + might work fine in your local environment but they might break once you deploy + them to your production server. + If the target documentation file is in another directory you'll need to make sure to include any relative directory path in the link.