Skip to content

MD-Plugins is a collection of Markdown and Vite plugins that make it easy to build markdown user interfaces in Vue and Quasar applications.

License

Notifications You must be signed in to change notification settings

md-plugins/md-plugins

Repository files navigation

Markdown Plugins Monorepo (md-plugins)

md-plugins - Collection of Markdown-it! plugins for Vue and Quasar
A collection of Markdown-it! plugins, Vite plugins, and App Extensions for Vue and Quasar.

Markdown-it! Plugins

@md-plugins/md-plugin-blockquote @md-plugins/md-plugin-codeblocks @md-plugins/md-plugin-containers @md-plugins/md-plugin-frontmatter @md-plugins/md-plugin-headers @md-plugins/md-plugin-image @md-plugins/md-plugin-imports @md-plugins/md-plugin-inlinecode @md-plugins/md-plugin-link @md-plugins/md-plugin-table @md-plugins/md-plugin-title @md-plugins/md-plugin-shared

Vite Plugins

@md-plugins/vite-md-plugin @md-plugins/vite-examples-plugin

Quasar App Extensions

@md-plugins/quasar-app-extension-vite-md-plugin @md-plugins/quasar-app-extension-q-press

GitHub code size in bytes GitHub repo size in bytes

npm @md-plugins/quasar-app-extension-qpress

PayPal donate button

Discord X

A collection of Markdown-It plugins and utilities designed for enhanced Markdown processing. This monorepo contains various plugins for handling specific Markdown features.

A collection of Vite plugins for transforming Markdown into Vue Single File Components (SFCs) and for handling raw SFC content.

A collection of App Extensions for Quasar Framework, providing enhanced Markdown support for Quasar applications, including Q-Press. The Q-Press App Extension is a powerful tool for Quasar developers that simplifies the integration of Markdown content into Quasar applications. It leverages the capabilities of Vite and various Markdown plugins to transform Markdown files into Vue components, enabling a seamless and efficient workflow for content management.

Inspired by Quasar Framework documentation and mdit-vue, this project aims to provide a comprehensive set of tools for working with Markdown content.

Overview

This monorepo provides:

  • Plugins to enhance Markdown rendering with features like blockquotes, inline code, tables, headers, and more.
  • A Vite plugin for seamless integration of Markdown into Vue projects.
  • A Vite plugin for handling raw SFC content.
  • Shared utilities for common processing tasks.

Table of Contents

Plugins

Plugin Description Readme
@md-plugins/md-plugin-imports Extracts and processes <script import> blocks from Markdown. README
@md-plugins/md-plugin-codeblocks Enhances code block rendering with syntax highlighting, tabs, and more. README
@md-plugins/md-plugin-blockquote Adds customizable CSS classes to blockquotes. README
@md-plugins/md-plugin-headers Extracts and processes headers for generating ToCs or managing headers. README
@md-plugins/md-plugin-inlinecode Adds a custom class to inline code blocks for styling. README
@md-plugins/md-plugin-link Converts Markdown links into Vue components for SPA-friendly routing. README
@md-plugins/md-plugin-table Adds custom classes and attributes to Markdown tables. README
@md-plugins/md-plugin-title Extracts the first header in Markdown as the page title. README
@md-plugins/md-plugin-frontmatter Extracts and processes frontmatter content from Markdown files. README
@md-plugins/md-plugin-containers Adds custom containers for callouts, warnings, and more. README
@md-plugins/shared Shared utilities and types for the plugins. README
viteMdPlugin Vite plugin for transforming Markdown into Vue SFCs. README
viteExamplesPlugin Vite plugin for loading and transforming example components and their raw source code for usage in your application. README
@md-plugins/vite-md-plugin Quasar app extension for enhanced Markdown support in Quasar Applications. README
@md-plugins/qPress The Ultimate Markdown Solution for Quasar Framework Applications. README

Installation

Clone the repository and use pnpm to install dependencies:

git clone https://github.com/md-plugins/md-plugins.git
cd md-plugins
pnpm install

Development

Building Packages

Build all packages in the monorepo:

pnpm build

Running Tests

Each package includes unit tests. To run all tests across the monorepo:

pnpm test

Linting

Ensure code quality across all packages:

pnpm lint

Contributing

We welcome contributions! Please open an issue or submit a pull request with your proposed changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

MD-Plugins is a collection of Markdown and Vite plugins that make it easy to build markdown user interfaces in Vue and Quasar applications.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published