https://github.com/adapttive/remark-external-preview

External Preview Plugin for Remark
https://github.com/adapttive/remark-external-preview

Last synced: 28 days ago
JSON representation

External Preview Plugin for Remark

• Host: GitHub
• URL: https://github.com/adapttive/remark-external-preview
• Owner: adapttive
• License: mit
• Created: 2021-03-06T17:44:17.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-18T20:43:13.000Z (8 months ago)
• Last Synced: 2024-11-09T13:23:18.342Z (about 1 month ago)
• Language: JavaScript
• Size: 79.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# remark-external-preview

External Preview Plugin for Remark

## Installation

`npm install @adapttive/remark-external-preview` or

`yarn add @adapttive/remark-external-preview`

## Usage

```js

const remark = require("remark");

const html = require('remark-html');

const externalPreview = require('@adapttive/remark-external-preview');

remark()

    .use(html)

    .use(externalPreview)

    .process(

        "# Hi" +

        "\n[@external:code:github](https://github.com/milindsingh/magento2-grumphp/blob/2d9be8cf5c9da07256af5194370e9a9326e30881/module/grumphp.yml#L1-L134)",

        function(err, output) {

            console.log(String(output))

            console.error(err)

        }

    );

```