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, be it a widget or a class, should be named after the component and placed in the right directory. For example, the API reference for the Kendo UI Grid is stored in the api/javascript/ui/grid.md file. The data source API is located in located in the api/javascript/data/datasource.md file.

Metadata

Set the title, page_title, and description attributes in the front matter as demonstrated below.

EXAMPLE

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

The title should be the name of the widget.

Do not 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.

EXAMPLE

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