You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2015/11/27 11:06:22 UTC
incubator-zeppelin git commit: Add basic documentation for Markdown
Repository: incubator-zeppelin
Updated Branches:
refs/heads/master 1285f4fbd -> a30aeb06b
Add basic documentation for Markdown
Author: Renjith Kamath <re...@gmail.com>
Closes #467 from r-kamath/markdownDocUpdate and squashes the following commits:
3ebed22 [Renjith Kamath] update top nav and add basepath
f7e954a [Renjith Kamath] Merge branch 'master' of https://github.com/apache/incubator-zeppelin into markdownDocUpdate
d839992 [Renjith Kamath] add link to markdown4j page
95442b4 [Renjith Kamath] Merge branch 'master' of https://github.com/apache/incubator-zeppelin into markdownDocUpdate
e429355 [Renjith Kamath] Add basic documentation for Markdown
Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/a30aeb06
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/a30aeb06
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/a30aeb06
Branch: refs/heads/master
Commit: a30aeb06b0f432eb5c4596aeaa803fd0ab12e259
Parents: 1285f4f
Author: Renjith Kamath <re...@gmail.com>
Authored: Thu Nov 26 11:16:59 2015 +0530
Committer: Lee moon soo <mo...@apache.org>
Committed: Fri Nov 27 19:07:03 2015 +0900
----------------------------------------------------------------------
docs/_includes/themes/zeppelin/_navigation.html | 2 +-
.../zeppelin/img/docs-img/markdown-example.png | Bin 0 -> 69359 bytes
.../docs-img/markdown-interpreter-setting.png | Bin 0 -> 32571 bytes
docs/docs.md | 2 +-
docs/interpreter/markdown.md | 22 +++++++++++++++++++
5 files changed, 24 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/a30aeb06/docs/_includes/themes/zeppelin/_navigation.html
----------------------------------------------------------------------
diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html
index c3f8956..10e97e5 100644
--- a/docs/_includes/themes/zeppelin/_navigation.html
+++ b/docs/_includes/themes/zeppelin/_navigation.html
@@ -40,7 +40,7 @@
<li><a href="{{BASE_PATH}}/pleasecontribute.html">Hive</a></li>
<li><a href="{{BASE_PATH}}/interpreter/ignite.html">Ignite</a></li>
<li><a href="{{BASE_PATH}}/interpreter/lens.html">Lens</a></li>
- <li><a href="{{BASE_PATH}}/pleasecontribute.html">Markdown</a></li>
+ <li><a href="{{BASE_PATH}}/interpreter/markdown.html">Markdown</a></li>
<li><a href="{{BASE_PATH}}/interpreter/postgresql.html">Postgresql, hawq</a></li>
<li><a href="{{BASE_PATH}}/pleasecontribute.html">Shell</a></li>
<li><a href="{{BASE_PATH}}/interpreter/spark.html">Spark</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/a30aeb06/docs/assets/themes/zeppelin/img/docs-img/markdown-example.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/markdown-example.png b/docs/assets/themes/zeppelin/img/docs-img/markdown-example.png
new file mode 100644
index 0000000..128d435
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/markdown-example.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/a30aeb06/docs/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png b/docs/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png
new file mode 100644
index 0000000..7b294e1
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/a30aeb06/docs/docs.md
----------------------------------------------------------------------
diff --git a/docs/docs.md b/docs/docs.md
index 28ee73a..8e338f7 100644
--- a/docs/docs.md
+++ b/docs/docs.md
@@ -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)
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/a30aeb06/docs/interpreter/markdown.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/markdown.md b/docs/interpreter/markdown.md
new file mode 100644
index 0000000..7c339d2
--- /dev/null
+++ b/docs/interpreter/markdown.md
@@ -0,0 +1,22 @@
+---
+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.
+Zeppelin uses markdown4j, for more examples and extension support checkout [markdown4j](https://code.google.com/p/markdown4j/)
+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="{{BASE_PATH}}/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="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-example.png" width="800px" />