Markdown Tag

Cool stuff that lets you embed markdown in your HTML.

Just like this:

<markdown-content>
# Markdown Render

normal **bold** _italic_ ~~strikethrough~~
</markdown-content>

Installation

pnpm add @dragon-fish/markdown-tag

Usage

As NPM package

// Simply import only, then you can use <markdown> tag in your HTML
import '@dragon-fish/markdown-tag'

// Or sometimes you may need to using the API
import { MarkdownElement } from '@dragon-fish/markdown-tag'
const md = MarkdownElement.createElement()
md.innerText = `
# Markdown Render

normal **bold** _italic_ ~~strikethrough~~
`
document.body.appendChild(md)

In browser

<!-- Simply load the script -->
<script src="https://unpkg.com/@dragon-fish/markdown-tag"></script>
<markdown-content>
  <!-- some markdown here -->
</markdown-content>

<!-- Or sometimes you may need to using the API -->
<script type="module">
  import { MarkdownElement } from 'https://unpkg.com/@dragon-fish/markdown-tag?module'
  const md = MarkdownElement.createElement()
  md.innerText = `
# Markdown Render

normal **bold** _italic_ ~~strikethrough~~
`
  document.body.appendChild(md)
</script>

Tag name alias

You can use MarkdownElement.install static method to replace the default <markdown-content> tag.

MarkdownElement.install('markdown-content')
//                      ↑ replace with your own tag name

P.S. If you are using the umd bundle in browser. Use window.MarkdownTagModule.MarkdownElement.install('your-tag-name') instead.

Trivals

I created this package as a practice for using CustomElements. Although it doesn't have much use, it can indeed help you insert content written in markdown anywhere on the web page at any time.