-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Documentation page parameters
Pierre Guceski edited this page Apr 16, 2020
·
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- [Optional - default:false]: Boolean, if set to true the current page isn't indexed by bots or by the documentation search -
beta- [Optional - default:false]: Boolean, if set to true the current page isn't included in the documentation website -
further_reading- [Optional]: Create a further reading section with the proper partial