HidemaruOwO/remark-directive
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add `when should I use this?

Browse source
This commit is contained in:
Titus Wormer 2021-10-21 20:58:20 +02:00
parent 98a3ce5666
commit eb3a552dab
No known key found for this signature in database
GPG key ID: E6E581152ED04E2E
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
readme.md
View file

@ -16,9 +16,25 @@ such).
This is a plugin that works with [unified][] (specifically, [remark][], for
markdown).
That means it’s easier to use than lower-level tools such as micromark or mdast,
which are abstracted away.
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!
from callouts, specifically styled blocks, forms, embeds, spoilers, anything!
## When should I use this?
This is one of the four ways to extend markdown: an arbitrary extension syntax.
(See [Extending markdown](https://github.com/micromark/micromark#extending-markdown)
in micromark’s docs for the more details and the alternatives).
This mechanism works well when you control who authors the markdown and it is
rendered in a place and by tooling you control.
Example use cases are building a docs website with some custom needs for your
project or company, or in blogging tools and static site generators.
It generally works well when authors are not expected to know the ins and outs
of HTML or JavaScript, but can be trusted to read a guide on how to embed a
tweet.
## Install