edems-dev_md-discord-syntax/packages/remark/README.md

@edems-dev/remark-discord-syntax

Remark plugin transforming Discord-style spoiler blocks (||spoiler||) and subtext lines (-# subtext) for MDX / Markdown.

Part of the md-discord-syntax repository.

Installation

npm install @edems-dev/remark-discord-syntax

Minimal Usage

import { remarkMdDiscordSyntax } from "@edems-dev/remark-discord-syntax";
import { remark } from "remark";

const file = await remark()
  .use(remarkMdDiscordSyntax)
  .process("This is a ||spoiler|| and\n-# subtext line");

Next.js (next.config.mjs)

import createMDX from "@next/mdx";

const withMDX = createMDX({
  options: {
    remarkPlugins: ["@edems-dev/remark-discord-syntax"],
  },
});

export default withMDX({
  pageExtensions: ["js", "jsx", "md", "mdx", "ts", "tsx"],
});

License

GPL-3.0 © Edems-DEV