Good documentation flows naturally. Links to navigate to the next page are at the end of each page. Create links to remind users of essential concepts introduced previously. There is a good chance that a reader skipped over these or forgot about them. Avoid: links that navigate users forward. It may break the flow of a documentation.

To create an link use: To refer page within your documentation use: Note: you can get by hovering over a section title and pressing link icon. Your browser URL display the updated link. Links to Subsection Linking to subsections is the same as linking to a top level section. Here is an example Use Subsection Shortcut if a subsection is within the same page: Index Page Clicking this index page link will have the same effect as clicking the documentation title at the top of the Navigation Panel To refer back to the top-level page use: external [Link Title](http://external/reference) internal [internal link](../dir-name/file-name.md#optional-page-section-id) [internal link](./file-name.md#optional-page-section-id) [internal link](dir-name/file-name#optional-page-section-id) page-section-id [Here is an example](flow/page-references#links-links-to-subsection) [Subsection Shortcut](#links) index [index page](/) [index page](/#link-to-subsection)

Linking to a local file will deploy the file along with the generated documentation. Clicking the link will open a file using the browser's default method. Download test json file Download [test json file](data/test.json)

Use after section title to set a custom anchor: Section With Custom Anchor {#anchori-id} ## Section With Custom Anchor {#my-custom-id}

Local links are automatically validated during documentation build time. You will get a build time error if you refer to a page or a section/sub-section that does not exist. Pass to enable external links validation. --validate-external-links