{"repo":"remarkjs/remark-directive","free":true,"listed":false,"github":"https://github.com/remarkjs/remark-directive","clone":"git clone https://github.com/remarkjs/remark-directive.git","description":"remark plugin to support directives","language":"JavaScript","stars":420,"topics":["remark","remark-plugin","markdown","generic","directive","extension","container"],"license":"MIT","category":"productivity","readme_excerpt":"remark-directive [![Build][badge-build-image]][badge-build-url] [![Coverage][badge-coverage-image]][badge-coverage-url] [![Downloads][badge-downloads-image]][badge-downloads-url] [![Size][badge-size-image]][badge-size-url] [remark][github-remark] plugin to support the [generic directives proposal][commonmark-directive-proposal] ( :cite[smith04] , ::youtube[Video of a cat in a box]{v=01ab2cd3efg} , and such). Contents What is this? When should I use this? Install Use API [ unified().use(remarkDirective[, options]) ](#unifieduseremarkdirective-options) Options Examples Example: YouTube Example: Styled blocks Authoring HTML CSS Syntax Syntax tree Types Compatibility Security Related Contribute License What is this? This package is a [unified][github-unified] ([remark][github-remark]) plugin to add support for directives: one syntax for arbitrary extensions in markdown. When should I use this? Directives are one of the four ways to extend markdown: an arbitrary extension syntax (see [Extending markdown][github-micromark-extending-markdown] in micromark’s docs for the alternatives and more info). This mechanism works well when you control the content: who authors it, what tools handle it, and where it’s displayed. When authors can read a guide on how to embed a tweet but are not expected to know the ins and outs of HTML or JavaScript. Directives don’t work well if you don’t know who authors content, what tools handle it, and where it ends up. Example use cases are a docs website f","default_branch":null,"files":null,"tree":[],"storefront":"/r/remarkjs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/remarkjs/remark-directive/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}