Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.47 KB

README.md

File metadata and controls

65 lines (41 loc) · 1.47 KB

<mark-down>

===================

This component is no longer actively maintained. Please use marked-element instead :)

See the component page for more information.

Install

Install the component using Bower:

$ bower install robdodson/mark-down --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:
<script src="bower_components/webcomponentsjs/webcomponents-lite.js"></script>
  1. Import Custom Element:
<link rel="import" href="bower_components/mark-down/mark-down.html">
  1. Start using it!
<mark-down>This is **awesome**</mark-down>

Playing With Your Element

If you wish to work on the element in isolation, I recommend that you use Polyserve to keep the bower dependencies in line. You can install it via:

npm install -g polyserve

And you can run it via:

polyserve

Once running, you can preview the element at http://localhost:8080/components/mark-down/.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT License © Rob Dodson