Directory Structure and Metadata

The API reference is parsed and thus must obey to certain rules.

File naming

The API reference for a certain component (widget or class) should be named after the component and placed in the right directory. For example the API reference for the Kendo grid is api/javascript/ui/grid.md. The data source API is in api/javascript/data/datasource.md.

Metadata

You need to set the title, page_title, description attributes in the front matter:

---
title: AutoComplete
page_title: <text>
description: <text>
---

The title should be the name of the widget (don't add the namespace). It is used in the left-hand navigation. The page_title is used as the <title></title> of the page. The description is used in <meta name="description">.

There is one optional attribute - position. Setting it will override the default sorting in the left-hand navigation.

---
title: AutoComplete
page_title: <text>
description: <text>
position: 0
---