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

Reword

Browse source
This commit is contained in:
Titus Wormer 2021-10-24 07:58:42 +02:00
parent 49608465e3
commit aa9c022ef5
No known key found for this signature in database
GPG key ID: E6E581152ED04E2E
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
readme.md
View file

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