Skip to content

Commit f805b17

Browse files
Add docs
1 parent 67125e0 commit f805b17

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

doc/content/user_guide/features.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,48 @@ To use them elsewhere, e.g. in Hugo templates, we provide an `svg-icon` partial.
9393
{{ partial "svg-icon" "my-icon" }}
9494
```
9595

96+
## External links
97+
98+
Links in the navbar and footer can be marked as external by adding `is_external: true`. This displays an external link indicator icon (↗)
99+
next to the link text and opens the link in a new tab.
100+
101+
### Navbar external links
102+
103+
```yaml
104+
params:
105+
navbar:
106+
- title: Documentation
107+
url: /docs/
108+
- title: GitHub
109+
url: https://github.com/your-org/your-repo
110+
is_external: true
111+
- title: More
112+
sublinks:
113+
- title: Internal Page
114+
url: /internal/
115+
- title: External Resource
116+
url: https://example.com
117+
is_external: true
118+
```
119+
120+
### Footer external links
121+
122+
```yaml
123+
params:
124+
footer:
125+
quicklinks:
126+
column1:
127+
title: "Links"
128+
links:
129+
- text: About
130+
link: /about/
131+
- text: GitHub Repository
132+
link: https://github.com/your-org/your-repo
133+
is_external: true
134+
```
135+
136+
The external link indicator automatically adapts to both light and dark colour modes.
137+
96138
## Mermaid diagrams
97139

98140
[Mermaid](https://mermaid.js.org/) diagrams are rendered from code blocks:

0 commit comments

Comments
 (0)