-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Code Samples
When you contribute to the Kendo UI Core API documentation, have in mind the following guidelines.
-
To better demonstrate the configuration options, include as many samples as possible in it—more than one per section is a plus.
-
Make sure a sample can be run as it is—include the required HTML and
<script>
tags, and place the JavaScript code in<script>
blocks. Use the Kendo UI Dojo to create the demo and then paste the code (the content of the<body>
only) in the documentation. -
Show something meaningful in the sample.
-
If you need remote data, use
http://demos.kendoui.com/service/products
and JSONP—the sample should be runnable at all costs. -
Use two spaces for indentation—while this is contrary to the Kendo UI coding conventions, it looks tidier and is also the default indentation in the Kendo UI Dojo.
-
All code samples in the API section should be runnable and, therefore, an Edit this example button appears above each sample. If a code snippet is not meant to be runnable, define it in the following way.
```pseudo ...non-runnable code snippet here... ```pseudo
Markdown Fundamentals
- Markdown Basics (Official GitHub Documentation)
- GitHub Flavored Markdown (Official GitHub Documentation)
Kendo UI Core API Documentation