summaryrefslogtreecommitdiffstats
path: root/packages/markdown/README.md
diff options
context:
space:
mode:
authorLauri Ojansivu <x@xet7.org>2019-04-20 15:18:33 +0300
committerLauri Ojansivu <x@xet7.org>2019-04-20 15:18:33 +0300
commit73e265d8fd050ae3daa67472b4465a5c49d68910 (patch)
tree677b233934a43d8f873e24c794ce289d85e3a9b7 /packages/markdown/README.md
parent6117097a93bfb11c8bd4c87a23c44a50e22ceb87 (diff)
downloadwekan-73e265d8fd050ae3daa67472b4465a5c49d68910.tar.gz
wekan-73e265d8fd050ae3daa67472b4465a5c49d68910.tar.bz2
wekan-73e265d8fd050ae3daa67472b4465a5c49d68910.zip
Include to Wekan packages directory contents, so that meteor command would build all directly.
This also simplifies build scripts. Thanks to xet7 !
Diffstat (limited to 'packages/markdown/README.md')
-rwxr-xr-xpackages/markdown/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/packages/markdown/README.md b/packages/markdown/README.md
new file mode 100755
index 00000000..96c5725e
--- /dev/null
+++ b/packages/markdown/README.md
@@ -0,0 +1,40 @@
+markdown
+========
+
+GitHub flavored markdown parser for Meteor based on marked.js newest version, updated by xet7.
+
+GFM tables and linebreaks are enabled by default.
+
+
+Usage
+-----
+
+Anywhere inside your template add markdown block and write markdown inside.
+
+Example:
+
+```
+{{#markdown}}
+
+...markdown text here...
+
+{{/markdown}}
+```
+
+That's it!
+
+
+Thanks to:
+----------
+
+- Christopher Jeffrey for <a href="https://github.com/chjj/marked" target="_blank">marked.js</a>
+
+- Bozhao Yu for original <a href="https://github.com/yubozhao/meteor-markdown" target="_blank">meteor-markdown</a> package (I just made this package compatible with Meteor 0.9+)
+
+- Bernhard Millauer - for contributions to this package
+
+- <a href="https://github.com/xet7">xet7</a> for updating to newest GFM package.
+
+License
+-------
+MIT