mirror of https://github.com/wekan/wekan
The Open Source kanban (built with Meteor). Keep variable/table/field names camelCase. For translations, only add Pull Request changes to wekan/i18n/en.i18n.json , other translations are done at https://transifex.com/wekan/wekan only.
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
![]() |
6 years ago | |
---|---|---|
.. | ||
.github | 6 years ago | |
bin | 6 years ago | |
docs | 6 years ago | |
lib | 6 years ago | |
man | 6 years ago | |
test | 6 years ago | |
.editorconfig | 6 years ago | |
.eslintignore | 6 years ago | |
.eslintrc.json | 6 years ago | |
.gitattributes | 6 years ago | |
.gitignore | 6 years ago | |
.travis.yml | 6 years ago | |
LICENSE.md | 6 years ago | |
Makefile | 6 years ago | |
README.md | 6 years ago | |
bower.json | 6 years ago | |
component.json | 6 years ago | |
index.js | 6 years ago | |
jasmine.json | 6 years ago | |
marked.min.js | 6 years ago | |
package.json | 6 years ago |
README.md
Marked
- ⚡ built for speed
- ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
- 🌐 works in a browser, on a server, or from a command line interface (CLI)
Demo
Checkout the demo page to see marked in action ⛹️
Docs
Our documentation pages are also rendered using marked 💯
Also read about:
Installation
CLI: npm install -g marked
In-browser: npm install marked
Usage
Warning: 🚨 Marked does not sanitize the output HTML by default 🚨
CLI
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>
Browser
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title>Marked in the browser</title>
</head>
<body>
<div id="content"></div>
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script>
document.getElementById('content').innerHTML =
marked('# Marked in the browser\n\nRendered by **marked**.');
</script>
</body>
</html>
License
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)