Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

mdast-util-lemmy-spoiler

aeharding231AGPL-3.0-only2.0.0TypeScript support: included

mdast extension to parse and serialize lemmy spoilers

unist, mdast, mdast-util, util, utility, markdown, markup, extension, lemmy, spoiler

readme

mdast-util-lemmy-spoiler

What is this?

This package contains two extensions that add support for lemmy spoiler syntax in markdown to mdast. These extensions plug into mdast-util-from-markdown (to support parsing spoilers in markdown into a syntax tree) and mdast-util-to-markdown (to support serializing spoilers in syntax trees to markdown).

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install mdast-util-lemmy-spoiler

In Deno with esm.sh:

import {spoilerFromMarkdown} from 'https://esm.sh/mdast-util-lemmy-spoiler@1'

In browsers with esm.sh:

<script type="module">
  import {spoilerFromMarkdown} from 'https://esm.sh/mdast-util-lemmy-spoiler@3?bundle'
</script>