remark-telegraph

remark plugin to translate markdown into Telegra.ph Nodes.

🇺🇦 Help Ukraine

I woke up on my 26th birthday at 5 am from the blows of russian missiles. They attacked the city of Kyiv, where I live, as well as the cities in which my family and friends live. Now my country is a war zone.

We fight for democratic values, freedom, for our future! Once again Ukrainians have to stand against evil, terror, against genocide. The outcome of this war will determine what path human history is taking from now on.

💛💙 Help Ukraine! We need your support! There are dozen ways to help us, just do it!

Table of Contents

• remark-telegraph
  • 🇺🇦 Help Ukraine
  • Table of Contents
  • 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.