README.md

Tweet markdown renderer

Render your tweets with entities to beautiful markdown.

Installing

You can install the latest package version for Node.js:

$ npm install tweet.md

How to use

Just as you think it should be used:

import { renderTweet } from "tweet.md";

const output = renderTweet(
  tweetObjectFromAPI,
  // + optional config
  {
    render: {
      quote: {
        // render quoted text above tweet text (false by default)
        aboveText: true,
      }
    },
  },
);

Examples

01-link.json5

Removing the 140 character limit from Direct Messages twittercommunity.com/t/removing-the…

---

02-multiline.json5

Tweet poems you like
at #TwitterPoetryClub
prose, sonnets and more

Via @bustle, learn how to wax poetic on Twitter: bustle.com/articles/10068…

---

03-russian.json5

Привет! С вами сегодня и всю неделю @pepelsbey, он же Вадим Макеев в прямом эфире из Осло, см. глобус Европы pic.twitter.com/clb7TLnxZS

---

04-ctags.json5

$APPL set to jump this morning. General rebound in the market today. Yesterday was a good time to buy into the panic.

---

05-emoji.json5

Twitter libraries are a great way to use our API. Did you know:

✨ 100+ libraries support the Twitter API
✨ In 25+ programming languages 🐍☕️♦️

Explore our curated list of community built libraries 📚

developer.twitter.com/en/docs/develo…

---

06-quote.json5

A nice GIF of the Performance Monitor coming to DevTools in Chrome 64 developers.google.com/web/updates/20…

Track your site’s performance realtime with @ChromeDevTools in 3 steps:

1. CMD+SHIFT+P
2. type 'per'
3. Select 'Sh… twitter.com/i/web/status/9…