0.0.1 • Published 8 months ago
wc-mdit v0.0.1
wc-mdit
A markdown-to-html web component.
⚙️ Installation
npm
npm i wc-mditscripts
<script src="https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/markdown-it/dist/wc-mdit.umd.js"></script>🚀 Example
import 'wc-mdit'
function App() {
return (
<wc-mdit content='# H1' theme='github-dark' />
// or
<wc-mdit src="https://raw.githubusercontent.com/huodoushigemi/wc-mdit/refs/heads/main/README.md" theme='github-dark' />
)
}📄 Props
| Attribute | Type | Description |
|---|---|---|
| src | String | URL to external markdown file. |
| content | String | |
| theme | String | |
| css | String | <style>{css}</style> |
| no-shadow | Boolean | If set, renders and stamps into light DOM instead. Please know what you are doing. |
| body-class | String | Class names forwarded to .markdown-body block. |
| body-style | String | Style forwarded to .markdown-body block. |
| options | Object | new MarkdownIt(options) |