centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add warning to docs about usage of absolute paths in links.

Browse Source 
Fixes #1757.
This commit is contained in:
devakker
2019-03-07 15:52:08 +01:00
committed by Waylan Limberg
parent 1683205f73
commit 32d2ed3bee
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/user-guide/writing-your-docs.md
View File

@@ -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.