https://github.com/silentroach/tweet.md

Render tweet into beautiful markdown
https://github.com/silentroach/tweet.md

markdown twitter

Last synced: 9 days ago
JSON representation

Render tweet into beautiful markdown

• Host: GitHub
• URL: https://github.com/silentroach/tweet.md
• Owner: silentroach
• Created: 2015-08-26T06:28:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-13T07:15:13.000Z (15 days ago)
• Last Synced: 2024-12-16T16:55:11.641Z (12 days ago)
• Topics: markdown, twitter
• Language: TypeScript
• Homepage:
• Size: 844 KB
• Stars: 24
• Watchers: 2
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tweet markdown renderer

[![npm](https://img.shields.io/npm/v/tweet.md.svg)](https://www.npmjs.com/package/tweet.md)

Render your [tweets](https://dev.twitter.com/overview/api/tweets) with [entities](https://dev.twitter.com/overview/api/entities) to beautiful markdown.

## Installing

You can install the latest package version for [Node.js](https://nodejs.org):

```

$ npm install tweet.md

```

## How to use

Just as you think it should be used:

```ts

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](examples/01-link.json5)

Removing the 140 character limit from Direct Messages [twittercommunity.com/t/removing-the…](https://t.co/h0I2M3P2vm "https://twittercommunity.com/t/removing-the-140-character-limit-from-direct-messages/41348/")

---

### [02-multiline.json5](examples/02-multiline.json5)

Tweet poems you like  

at [#TwitterPoetryClub](https://twitter.com/search?q=%23TwitterPoetryClub)  

prose, sonnets and more  

Via [@bustle](https://twitter.com/bustle "Bustle"), learn how to wax poetic on Twitter: [bustle.com/articles/10068…](http://t.co/vItyyGqX7R "http://www.bustle.com/articles/100683-twitterpoetryclub-members-share-their-love-of-poetry-in-140-characters-or-less")

---

### [03-russian.json5](examples/03-russian.json5)

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

---

### [04-ctags.json5](examples/04-ctags.json5)

[$APPL](https://twitter.com/search?q=%23APPL&src=ctag) set to jump this morning. General rebound in the market today. Yesterday was a good time to buy into the panic.

---

### [05-emoji.json5](examples/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…](https://t.co/mgXiWmt9SY "https://developer.twitter.com/en/docs/developer-utilities/twitter-libraries")

---

### [06-quote.json5](examples/06-quote.json5)

A nice GIF of the Performance Monitor coming to DevTools in Chrome 64 [developers.google.com/web/updates/20…](https://t.co/2xpId3DFro "https://developers.google.com/web/updates/2017/11/devtools-release-notes#perf-monitor") 

> Track your site’s performance realtime with [@ChromeDevTools](https://twitter.com/ChromeDevTools "Chrome DevTools") in 3 steps:

>

> 1. CMD+SHIFT+P

> 2. type 'per'

> 3. Select 'Sh… [twitter.com/i/web/status/9…](https://t.co/UVvpIlCkrk "https://twitter.com/i/web/status/936661298603089920")