mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
docs: Update markdown docs config, examples
This commit is contained in:
parent
2b6516cad3
commit
d228423d63
4 changed files with 32 additions and 2 deletions
Binary file not shown.
|
After Width: | Height: | Size: 258 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 66 KiB |
|
|
@ -25,14 +25,44 @@ limitations under the License.
|
|||
|
||||
## Overview
|
||||
[Markdown](http://daringfireball.net/projects/markdown/) is a plain text formatting syntax designed so that it can be converted to HTML.
|
||||
Apache Zeppelin uses markdown4j. For more examples and extension support, please checkout [here](https://code.google.com/p/markdown4j/).
|
||||
Apache Zeppelin uses [markdown4j](https://github.com/sirthias/pegdown) and [pegdown](https://github.com/sirthias/pegdown) as markdown engines.
|
||||
|
||||
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.
|
||||
In Zeppelin, Markdown interpreter is enabled by default and uses [markdown4j](https://github.com/sirthias/pegdown) engine.
|
||||
|
||||
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png" width="60%" />
|
||||
|
||||
## Configuration
|
||||
<table class="table-configuration">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Default Value</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>markdown.parser.type</td>
|
||||
<td>markdown4j</td>
|
||||
<td>Markdown Parser Type. <br/> Available values: markdown4j, pegdown.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Example
|
||||
|
||||
The following example demonstrates the basic usage of Markdown in a Zeppelin notebook.
|
||||
|
||||
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-example.png" width="70%" />
|
||||
|
||||
### Markdowj4 Parser
|
||||
|
||||
`markdown4j` parser provides [YUML](http://yuml.me/) and [Websequence](https://www.websequencediagrams.com/) extensions
|
||||
|
||||
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-example-markdown4j-parser.png" width="70%" />
|
||||
|
||||
|
||||
### Pegdown Parser
|
||||
|
||||
`pegdown` parser provides github flavored markdown.
|
||||
|
||||
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-example-pegdown-parser.png" width="70%" />
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue