1000ch / x-marked

Web Components which renders markdown using marked.

Home Page:https://1000ch.github.io/x-marked/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

x-marked GitHub Actions Status

Web Components which renders markdown using marked.

Install

Using npm:

$ npm install x-marked

Usage

Import XMarked and register it as a custom element.

<script type="module">
import XMarked from 'https://unpkg.com/x-marked';

customElements.define('x-marked', XMarked);
</script>

Put <x-marked>.

<x-marked>
# x-marked

Web Components which renders markdown using [marked](https://github.com/markedjs/marked).
</x-marked>

API

highlight attribute/property

Boolean attribute/property to enable highlight.

highlight-theme/highlightTheme attribute/property

String attribute/property to specify the theme of syntax highlight. you can specify it by choosing from PrismJS/prism-themes without .css extension.

License

MIT © Shogo Sensui

About

Web Components which renders markdown using marked.

https://1000ch.github.io/x-marked/

License:MIT License


Languages

Language:TypeScript 63.5%Language:HTML 33.3%Language:JavaScript 3.2%