Skip to content

Commit

Permalink
Update Editing-the-documentation.md with tip on link validation
Browse files Browse the repository at this point in the history
  • Loading branch information
al-fisher committed Nov 22, 2023
1 parent 449b551 commit 7b5609f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/Contributing/Editing-the-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ Links to other documentation pages should be relative URLs (starting with a `/`)

This way of providing URL to pages is required because MkDocs reflects the markdown files starting from the root `documentation`.


!!! tip


If using Visual Studio Code, enable Error Reporting on Markdown files and Link Validation in settings. VS Code will then check the validity of local links and cross referencing across your Markdown files, flagging warnings where links are invalid. [VS Code Link Validation](https://code.visualstudio.com/docs/languages/markdown#_link-validation)

### Alternative (not recommended)
If you are editing a specific nested page you can also use URLs relative to the current page. Some examples:
- To link to the [Getting started for developers](../Getting-started-for-developers) page, relative to this current page (Editing-the-documentation), you can provide: `../Getting-started-for-developers`.
Expand Down

0 comments on commit 7b5609f

Please sign in to comment.