JSPM

  • Created
  • Published
  • Downloads 25808
  • Score
    100M100P100Q152671F

Package Exports

  • svelte-exmarkdown
  • svelte-exmarkdown/ExtensibleSvelteMarkdown.svelte
  • svelte-exmarkdown/contexts
  • svelte-exmarkdown/gfm
  • svelte-exmarkdown/gfm/Del.svelte
  • svelte-exmarkdown/gfm/ListItem.svelte
  • svelte-exmarkdown/gfm/Table.svelte
  • svelte-exmarkdown/gfm/TableCell.svelte
  • svelte-exmarkdown/gfm/TableRow.svelte
  • svelte-exmarkdown/package.json
  • svelte-exmarkdown/renderer
  • svelte-exmarkdown/renderer/Blockquote.svelte
  • svelte-exmarkdown/renderer/Children.svelte
  • svelte-exmarkdown/renderer/Code.svelte
  • svelte-exmarkdown/renderer/Emphasis.svelte
  • svelte-exmarkdown/renderer/Heading.svelte
  • svelte-exmarkdown/renderer/Html.svelte
  • svelte-exmarkdown/renderer/Image.svelte
  • svelte-exmarkdown/renderer/InlineCode.svelte
  • svelte-exmarkdown/renderer/Link.svelte
  • svelte-exmarkdown/renderer/List.svelte
  • svelte-exmarkdown/renderer/ListItem.svelte
  • svelte-exmarkdown/renderer/Paragraph.svelte
  • svelte-exmarkdown/renderer/Renderer.svelte
  • svelte-exmarkdown/renderer/Strong.svelte
  • svelte-exmarkdown/renderer/Table.svelte
  • svelte-exmarkdown/renderer/Text.svelte
  • svelte-exmarkdown/renderer/ThematicBreak.svelte
  • svelte-exmarkdown/types
  • svelte-exmarkdown/utils

Readme

svelte-exmarkdown

Svelte component to render markdown.

Motivation

svelte-markdown is a good component package. However, it is not extensible. You cannot use custom syntax(e.g. KaTeX).

MDsveX is another good package. However, it is a preprocessor. Not suitable for dynamic rendering.

We need pluggable and dynamic markdown renderer in svelte like react-markdown.

Usage

<script>
    import Markdown from 'svelte-exmarkdown';
    let md = '# Hello world!';
</script>

<textarea bind:value={md} />
<Markdown {md} />

with GFM

<script>
    import Markdown from 'svelte-exmarkdown';
    import { gfmPlugin } from 'svelte-exmarkdown/gfm';
    let md = '# Hello world!';
</script>

<textarea bind:value={md} />
<Markdown {md} plugins={[gfmPlugin]} />

Playground

https://ssssota.github.io/svelte-exmarkdown