inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-11-04 06:25:39 +00:00
Code Activity

Update README.md

Browse Source
This commit is contained in:
Oliver Walters
2020-10-19 11:18:26 +11:00
parent 9150675a56
commit 3c531034d7
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

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