portails/content/docs/reference/example.md

26 lines
849 B
Markdown
Raw Normal View History

2023-09-08 17:51:40 +02:00
---
title: "Example Reference"
description: "Reference pages are ideal for outlining how things work in terse and clear terms."
2023-09-08 17:51:40 +02:00
summary: ""
date: 2023-09-07T16:13:18+02:00
lastmod: 2023-09-07T16:13:18+02:00
draft: false
menu:
docs:
parent: ""
identifier: "example-ee51430687e728ba6e68dea3359133ad"
weight: 910
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
2023-09-08 17:51:40 +02:00
---
Reference pages are ideal for outlining how things work in terse and clear terms. Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what your documenting.
## Further reading
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework