Add basic documentation for Markdown

This commit is contained in:
Renjith Kamath 2015-11-24 11:08:30 +05:30
parent 6cfb32e5f6
commit e4293554c6
4 changed files with 22 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

View file

@ -38,7 +38,7 @@ limitations under the License.
* [hive](./pleasecontribute.html)
* [ignite](./interpreter/ignite.html)
* [lens](./interpreter/lens.html)
* [md](./pleasecontribute.html)
* [md](./interpreter/markdown.html)
* [postgresql, hawq](./interpreter/postgresql.html)
* [sh](./pleasecontribute.html)
* [spark](./interpreter/spark.html)

View file

@ -0,0 +1,21 @@
---
layout: page
title: "Markdown Interpreter"
description: "Markdown Interpreter"
group: manual
---
{% include JB/setup %}
## Markdown Interpreter for Apache Zeppelin
### Overview
[Markdown](http://daringfireball.net/projects/markdown/) is a plain text formatting syntax designed so that it can be converted to HTML.
In Zeppelin notebook you can use ``` %md ``` in the beginning of a paragraph to invoke the Markdown interpreter to generate static html from Markdown plain text.
In Zeppelin, Markdown interpreter is enabled by default.
<img src="/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png" width="600px" />
### Example
The following example demonstrates the basic usage of Markdown in a Zeppelin notebook.
<img src="/assets/themes/zeppelin/img/docs-img/markdown-example.png" width="800px" />