-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Directory Structure and Metadata
The Kendo UI Core API reference is parsed and thus must stick to certain rules.
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 widget is stored in the api/javascript/ui/grid.md
file. The data source API is located in the api/javascript/data/datasource.md
file.
-
Set the
title
,page_title
, anddescription
attributes in the front meter.The
title
should be the name of the widget and 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">
.Do not add namespaces.
--- title: AutoComplete page_title: <text> description: <text> ---
-
(Optional) Set
position
to override the default sorting in the left-hand navigation.--- title: AutoComplete page_title: <text> description: <text> position: 0 ---
Markdown Fundamentals
- Markdown Basics (Official GitHub Documentation)
- GitHub Flavored Markdown (Official GitHub Documentation)
Kendo UI Core API Documentation