Directory

marked-element - Vaadin Add-on Directory

Element wrapper for the marked library marked-element - Vaadin Add-on Directory
[![Published on NPM](https://img.shields.io/npm/v/@polymer/marked-element.svg)](https://www.npmjs.com/package/@polymer/marked-element) [![Build status](https://travis-ci.org/PolymerElements/marked-element.svg?branch=master)](https://travis-ci.org/PolymerElements/marked-element) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/marked-element) ## <marked-element> Element wrapper for the [marked](https://github.com/chjj/marked) library. `` accepts Markdown source, and renders it to a child element with the slot `markdown-html`. This child element can be styled as you would a normal DOM element. If you do not provide a child element with the `markdown-html` slot, the Markdown source will still be rendered, but to a shadow DOM child that cannot be styled. See: [Documentation](https://www.webcomponents.org/element/@polymer/marked-element), [Demo](https://www.webcomponents.org/element/@polymer/marked-element/demo/demo/index.html). ## Usage ### Installation ``` npm install --save @polymer/marked-element ``` ### In an html file ```html
``` ### In a Polymer 3 element ```js import {PolymerElement, html} from '@polymer/polymer'; import '@polymer/marked-element/marked-element.js'; class SampleElement extends PolymerElement { static get template() { return html`
`; } } customElements.define('sample-element', SampleElement); ``` ## Contributing If you want to send a PR to this element, here are the instructions for running the tests and demo locally: ### Installation ```sh git clone https://github.com/PolymerElements/marked-element cd marked-element npm install npm install -g polymer-cli ``` ### Running the demo locally ```sh polymer serve --npm open http://127.0.0.1:/demo/ ``` ### Running the tests ```sh polymer test --npm ```