From 3c531034d771436af6824521db2b447d4289fab0 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 19 Oct 2020 11:18:26 +1100 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0a85eb7..a628325 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,24 @@ Once the server is running, it will monitor the documentation files for any chan Refer to the [reference documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) to customize the admonition block to the use-case (eg. warning, missing, info, etc.). +### Internal Links + +Links to internal documentation pages **must** use relative pathing, otherwise the link will be broken by the readthedocs URL formatting. + +For example, to link to the page `/part/views` from `/stock/stocktake`, the link must be formed as follows: + +``` +Click [here](../../part/views) +``` + +*Formatting the link as follows:* + +``` +Click [here](/part/views) +``` + +*will result in a broken link.* + ### Images Images are served from the `./docs/assets/images` folder and can be added as follow: