-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Documentation page parameters
Kari Halsted edited this page May 10, 2021
·
16 revisions
List of available parameters for documentation pages:
-
title
- [Required]: Title of your documentation page -
kind
- [Required]: Type of your documentation page, can be documentation, faq, apicontent or apicode -
description
- [Required]: One line description for your current page -
aliases
- [Optional]: List of link used as aliases for your documentation page -
external_redirect
- [Optional]: A link to redirect to when accessing this documentation page -
is_public
- Boolean, if set to false the current page isn't built or published in the docs site -
beta
- [Optional - default:false]: Boolean, if set to true the current page isn’t indexed or searched, is only accessible by direct URL -
further_reading
- [Optional]: Create a further reading section with the proper partial