marked-element
Element wrapper for the marked library
<marked-element>
Element wrapper for the marked library.
<marked-element> 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, Demo.
Usage
Installation
npm install --save @polymer/marked-element
In an html file
<html>
<head>
<script type="module">
import '@polymer/marked-element/marked-element.js';
</script>
<style>
[slot="markdown-html"] p {
color: red;
}
</style>
</head>
<body>
<marked-element>
<div slot="markdown-html"></div>
<script type="text/markdown">
Check out my markdown!
We can even embed elements without fear of the HTML parser mucking up their
textual representation:
```html
<awesome-sauce>
<div>Oops, I'm about to forget to close this div.
</awesome-sauce>
```
</script>
</marked-element>
</body>
</html>
In a Polymer 3 element
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/marked-element/marked-element.js';
class SampleElement extends PolymerElement {
static get template() {
return html`
<style>
[slot="markdown-html"] p {
color: red;
}
</style>
<marked-element>
<div slot="markdown-html"></div>
<script type="text/markdown">
Check out my markdown!
We can even embed elements without fear of the HTML parser mucking up their
textual representation:
\`\`\`html
<awesome-sauce>
<div>Oops, I'm about to forget to close this div.
</awesome-sauce>
\`\`\`
</script>
</marked-element>
`;
}
}
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
git clone https://github.com/PolymerElements/marked-element
cd marked-element
npm install
npm install -g polymer-cli
Running the demo locally
polymer serve --npm
open http://127.0.0.1:<port>/demo/
Running the tests
polymer test --npm
Links
Compatibility
Was this helpful? Need more help?
Leave a comment or a question below. You can also join
the chat on Discord or
ask questions on StackOverflow.
Version
Dependencies
- marked#~0.3.9
- @polymer/polymer#^3.0.0
- Released
- 2018-09-14
- Maturity
- IMPORTED
- License
- BSD 3-clause "New" or "Revised" License
Compatibility
- Framework
- Polymer 1.0+
- Polymer 3.0+
- Polymer 2.0+ in 2.4.0
- Browser
- Browser Independent
marked-element - Vaadin Add-on Directory
Element wrapper for the marked library
View on GitHub
Online Demo
Documentation
GitHub Homepage
Issue tracker
License
marked-element version 0.8.0
### Dependencies
* polymer#Polymer/polymer#v0.8.0-rc.4
* marked#~0.3.3
marked-element version 0.8.1
### Dependencies
* polymer#Polymer/polymer#v0.8.0-rc.4
* marked#~0.3.3
marked-element version 0.8.2
### Dependencies
* polymer#Polymer/polymer#v0.8.0-rc.6
* marked#~0.3.3
marked-element version 0.8.3
### Dependencies
* polymer#Polymer/polymer#v0.8.0-rc.7
* marked#~0.3.3
marked-element version 0.9.0
### Dependencies
* polymer#Polymer/polymer#v0.9.0-rc.1
* marked#~0.3.3
marked-element version 0.9.1
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^0.9.0
marked-element version 0.9.2
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^0.9.0
marked-element version 1.0.0
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.0.0
marked-element version 1.0.1
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.0.0
marked-element version 1.0.2
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.0.0
marked-element version 1.1.0
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.0.0
marked-element version 1.1.1
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.1.2
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 0.0.1
### Dependencies
* marked#~0.3.3
* @polymer/polymer#^1.2.5-npm-test.2
marked-element version 0.0.3
### Dependencies
* marked#~0.3.3
* @polymer/polymer#^1.2.5-npm-test.2
marked-element version 1.1.3
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.2.0
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.3.0
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.3.1
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.3.2
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.4.0
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.4.1
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 1.4.2
### Dependencies
* marked#~0.3.3
* polymer#Polymer/polymer#^1.1.0
marked-element version 2.0.0
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.1.0
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.1.1
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.2.0
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.3.0
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 3.0.0-pre.1
### Dependencies
* @polymer/polymer#^3.0.0-pre.1
marked-element version 2.3.1
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.3.2
### Dependencies
* marked#~0.3.6
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.3.3
### Dependencies
* marked#~0.3.9
* polymer#Polymer/polymer#1.9 - 2
marked-element version 3.0.0-pre.2
### Dependencies
* @polymer/polymer#^3.0.0-pre.1
marked-element version 3.0.0-pre.3
### Dependencies
* @polymer/polymer#^3.0.0-pre.3
marked-element version 3.0.0-pre.4
### Dependencies
* @polymer/polymer#^3.0.0-pre.4
marked-element version 3.0.0-pre.6
### Dependencies
* @polymer/polymer#^3.0.0-pre.6
marked-element version 3.0.0-pre.7
### Dependencies
* @polymer/polymer#^3.0.0-pre.7
marked-element version 3.0.0-pre.8
### Dependencies
* @polymer/polymer#^3.0.0-pre.7
marked-element version 3.0.0-pre.10
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.10
marked-element version 2.3.4
### Dependencies
* marked#~0.3.9
* polymer#Polymer/polymer#1.9 - 2
marked-element version 2.4.0
### Dependencies
* marked#~0.3.9
* polymer#Polymer/polymer#1.9 - 2
marked-element version 3.0.0-pre.11
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.10
marked-element version 3.0.0-pre.12
### Dependencies
* marked#~0.3.9
* @polymer/polymer#3.0.0-pre.12
marked-element version 3.0.0-pre.13
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.13
marked-element version 3.0.0-pre.14
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.13
marked-element version 3.0.0-pre.15
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.13
marked-element version 3.0.0-pre.16
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.13
marked-element version 3.0.0-pre.17
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0-pre.13
marked-element version 3.0.0-pre.18
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.19
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.20
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.21
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.22
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.23
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.24
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.25
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0-pre.26
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.0
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0
marked-element version 3.0.1
### Dependencies
* marked#~0.3.9
* @polymer/polymer#^3.0.0