Package Exports

remark-telegraph
remark-telegraph/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-telegraph) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-telegraph

remark plugin to translate markdown into Telegra.ph Nodes.

Motivation
Requirements
Installation
Usage
Examples
Contribute

Motivation

Telegraph Api demands a page content to be represented as array of Node. In case markdown works better for you, remark-telegraph plugin could be a cure. It is an remark plugin, so can be used in combination with the whole ecosystem

Requirements

To use library you need to have node and npm installed in your machine:

node >=10
npm >=6

Package is continuously tested on darwin, linux and win32 platforms. All active and maintenance LTS node releases are supported.

Installation

To install the library run the following command

  npm i --save remark-telegraph

Usage

import remarkParse from 'remark-parse';
import remarkTelegraph from 'remark-telegraph';
import unified from 'unified';

async function createPage(markdown) {
    const vFile = await unified()
        .use(remarkParse)
        .use(remarkTelegraph)
        .process(markdown);

    const nodes = JSON.parse(vFile.contents);

    console.log('Create Page :', nodes);
}

Note: for unified>=10 and remark-parse>=10 remark had been moved to ESM. So for the latest versions, usage samples may vary a bit.

Examples

See the example of markdown-it sample transformation on telegra.ph. Check raw nodes in examples folder.

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.