<!-- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

{% include JB/setup %}

Markdown Interpreter for Apache Zeppelin

<div id="toc"></div>

Overview

Markdown is a plain text formatting syntax designed so that it can be converted to HTML. Apache Zeppelin uses flexmark and markdown4j as markdown parsers.

In Zeppelin notebook, you can use %md in the beginning of a paragraph to invoke the Markdown interpreter and generate static html from Markdown plain text.

In Zeppelin, Markdown interpreter is enabled by default and uses the flexmark parser.

Example

The following example demonstrates the basic usage of Markdown in a Zeppelin notebook.

Mathematical expression

Markdown interpreter leverages %html display system internally. That means you can mix mathematical expressions with markdown syntax. For more information, please see Mathematical Expression section.

Configuration

<table class="table-configuration"> <tr> <th>Name</th> <th>Default Value</th> <th>Description</th> </tr> <tr> <td>markdown.parser.type</td> <td>flexmark</td> <td>Markdown Parser Type. Available values: flexmark, markdown4j.</td> </tr> </table>

Flexmark parser (Default Markdown Parser)

CommonMark/Markdown Java parser with source level AST.

flexmark parser provides YUML and Websequence extensions also.

Markdown4j Parser

Since flexmark parser is more accurate and provides much more markdown syntax markdown4j option might be removed later. But keep this parser for the backward compatibility.