Skip to content

Saeris/markdown

Repository files navigation

markdown

A collection of markdown-it plugins, remark plugins, and VSCode Markdown Preview extensions that add extended syntax support for semantic HTML elements.


πŸ“¦ Packages

Each syntax feature is implemented as a matched set: a markdown-it plugin for server-side rendering pipelines, a remark plugin for unified/rehype pipelines, and a VSCode extension for live preview support.

Syntax HTML markdown-it remark VSCode
--delete-- <del> mdit-del remd-del markdown-del
++insert++ <ins> mdit-ins remd-ins markdown-ins
==mark== <mark> mdit-mark remd-mark markdown-mark
[[kbd]] <kbd> mdit-kbd remd-kbd markdown-kbd
H~2~O <sub> mdit-sub remd-sub markdown-sub
31^st^ <sup> mdit-sup remd-sup markdown-sup
*[term]: Title <abbr> mdit-abbr remd-abbr markdown-abbr
{本|ほん} <ruby> mdit-ruby remd-ruby markdown-denden-furigana
![](...img.svg) n/a mdit-inline-svg remd-inline-svg markdown-inline-svg

πŸ”§ Local Development

This project uses Vite+ (vp), a unified toolchain that wraps Vite, Vitest, Oxlint, Oxfmt, and more under a single CLI. Install it globally before getting started. Vite+ will automatically use the preferred package manager for this project (Yarn).

Install dependencies:

vp install

Run all checks (format, lint, type-check):

vp check

Run tests:

vp test

Build all packages:

vp run -r build

πŸ“£ Acknowledgements

The plugins in this collection are forked and modernized from the following upstream projects:


πŸ₯‚ License

Released under the MIT license Β© Drake Costa.

About

πŸ–‹ Collection of Markdown Plugins for the Remark and Markdown-It ecosystems

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors