Add what is this?

This commit is contained in:
Titus Wormer 2021-10-21 20:43:57 +02:00
parent fb2237e525
commit 98a3ce5666
No known key found for this signature in database
GPG key ID: E6E581152ED04E2E

View file

@ -12,6 +12,14 @@
(`:cite[smith04]`, `::youtube[Video of a cat in a box]{v=01ab2cd3efg}`, and (`:cite[smith04]`, `::youtube[Video of a cat in a box]{v=01ab2cd3efg}`, and
such). such).
## What is this?
This is a plugin that works with [unified][] (specifically, [remark][], for
markdown).
It adds support for a syntax that allows arbitrary extensions in markdown.
You use it with some code specific to match your needs, to allow for anything
from callouts, specifically styled blocks, forms, spoilers, anything!
## Install ## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c): This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
@ -190,6 +198,8 @@ abide by its terms.
[author]: https://wooorm.com [author]: https://wooorm.com
[unified]: https://github.com/unifiedjs/unified
[remark]: https://github.com/remarkjs/remark [remark]: https://github.com/remarkjs/remark
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting [xss]: https://en.wikipedia.org/wiki/Cross-site_scripting