Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 70c96a8

Browse files
Update readme
1 parent 4cee4db commit 70c96a8

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,14 @@ Please follow these best practices when writing documentation in this repository
8888
If needed, you can also [highlight a specific line](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences).
8989
- **Internal links:** Use the [`ref` or `relref` shortcode](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) when creating non-external links (but still use the markdown native image linking, ref doesn't work there).
9090
You can either use `ref` or `relref`, the point is to have compile time internal-link checks (which works for both).
91+
92+
```text
93+
# Do this
94+
Configuration options are [here]({{< ref "/references/configuration" >}})
95+
96+
# Don't do this
97+
Configuration options are [here](https://docs.localstack.cloud/references/configuration/)
98+
```
9199
- **Code snippets:** For snippets, make sure you indicate the programming/markup language so that proper syntax highlighting is used.
92100
Use `bash` only for Bash scripts, and use `text` for shell outputs or command examples.
93101
The full list of the supported languages [here](https://gohugo.io/content-management/syntax-highlighting/).

0 commit comments

Comments
 (0)