Skip to content

howking/marked-element

This branch is 79 commits behind PolymerElements/marked-element:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Aug 15, 2017
0e993fa · Aug 15, 2017
Mar 23, 2016
May 24, 2017
Aug 15, 2017
May 3, 2017
May 12, 2017
May 17, 2016
May 20, 2017
Jul 10, 2017
May 26, 2015
May 26, 2015
Aug 15, 2017
Mar 17, 2015

Repository files navigation

Build status

<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.

The Markdown source can be specified several ways:

Use the markdown attribute to bind markdown

<marked-element markdown="`Markdown` is _awesome_!">
  <div slot="markdown-html"></div>
</marked-element>

Use <script type="text/markdown"> element child to inline markdown

<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>

Use <script type="text/markdown" src="URL"> element child to specify remote markdown

<marked-element>
  <div slot="markdown-html"></div>
  <script type="text/markdown" src="../guidelines.md"></script>
</marked-element>

Note that the <script type="text/markdown"> approach is static. Changes to the script content will not update the rendered markdown!

Though, you can data bind to the src attribute to change the markdown.

<marked-element>
  <div slot="markdown-html"></div>
  <script type="text/markdown" src$="[[source]]"></script>
</marked-element>
...
<script>
  ...
  this.source = '../guidelines.md';
</script>

Styling

If you are using a child with the markdown-html slot, you can style it as you would a regular DOM element:

[slot="markdown-html"] p {
  color: red;
}

[slot="markdown-html"] td:first-child {
  padding-left: 24px;
}

About

Element wrapper for the marked library

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 100.0%