<markdown-awesome>
real-time markdown preview and syntax highlighting
Demo
Install
Install the component using Bower:
$ bower install markdown-awesome --save
Or download as ZIP.
Usage
-
Import Web Components' polyfill:
<script src="bower_components/platform/platform.js"></script>
-
Import Custom Element:
<link rel="import" href="bower_components/markdown-awesome/dist/markdown-editor.html">
-
Start using it!
<markdown-editor></markdown-editor>
Options
Attribute | Options | Default | Description |
---|---|---|---|
foo |
string | bar |
Lorem ipsum dolor. |
Methods
Method | Parameters | Returns | Description |
---|---|---|---|
unicorn() |
None. | Nothing. | Magic stuff appears. |
Events
Event | Description |
---|---|
onsomething |
Triggers when something happens. |
Development
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
-
$ [sudo] npm install -g bower grunt-cli
-
Install local dependencies:
$ bower install && npm install
-
To test your project, start the development server and open
http://localhost:8000
.$ grunt server
-
To build the distribution files before releasing a new version.
$ grunt build
-
To provide a live demo, send everything to
gh-pages
branch.$ grunt deploy
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
History
For detailed changelog, check Releases.