Skip to content

Using unifined as the base, the next-generation vue-markdown renderer supports Worker and optimal math formula rendering performance.

License

Notifications You must be signed in to change notification settings

UnboundedWeb/vue-markdown-next

Repository files navigation

Vue Markdown Next

License: MIT pnpm

Next-generation markdown parser and Vue renderer with high-performance Worker support.

中文文档 | Documentation

Features

  • High Performance: Built on unified/remark/rehype ecosystem with optimized rendering
  • Worker Support: Multi-threaded parsing with Web Workers and Worker Pool for non-blocking UI
  • Rich Syntax: GitHub Flavored Markdown (GFM), math formulas (MathJax), and syntax highlighting
  • Vue 3 Integration: Seamless Vue components rendering from markdown AST
  • Extensible: Hook system for custom markdown node processing
  • Type Safe: Full TypeScript support

Packages

This monorepo contains:

Installation

npm install @markdown-next/parser @markdown-next/vue
# or
pnpm add @markdown-next/parser @markdown-next/vue
# or
yarn add @markdown-next/parser @markdown-next/vue

Basic Usage

<script setup>
import { MarkdownRenderer } from '@markdown-next/vue';

const markdown = '# Hello World\n\nThis is **markdown**!';
</script>

<template>
  <MarkdownRenderer :markdown="markdown" />
</template>

Tech Stack

  • Parser: unified, remark, rehype
  • Worker: Comlink for seamless Worker communication
  • Plugins: remark-math, rehype-mathjax, remark-gfm
  • Build: tsup, vite
  • Test: vitest
  • Docs: VitePress

Documentation

For detailed documentation, examples, and API reference, visit:

Requirements

  • Node.js >= 16.0.0
  • pnpm >= 8.0.0

License

MIT

Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the repository
  2. Create your feature branch from main
  3. Make your changes:
    • For documentation-only changes: Submit PR to docs branch
    • For code changes (with or without docs): Submit PR to main branch
  4. Commit your changes with clear commit messages
  5. Push to your fork
  6. Open a Pull Request

For detailed contribution guidelines, please read CONTRIBUTING.md.

Links

About

Using unifined as the base, the next-generation vue-markdown renderer supports Worker and optimal math formula rendering performance.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •