https://github.com/bbecquet/thread-reader-reader
Parse Twitter thread already simplified by third-party Thread Reader app, and produce dead simple HTML
https://github.com/bbecquet/thread-reader-reader
Last synced: about 1 year ago
JSON representation
Parse Twitter thread already simplified by third-party Thread Reader app, and produce dead simple HTML
- Host: GitHub
- URL: https://github.com/bbecquet/thread-reader-reader
- Owner: bbecquet
- Created: 2020-05-14T16:35:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T05:57:29.000Z (over 3 years ago)
- Last Synced: 2025-03-28T10:11:40.315Z (about 1 year ago)
- Language: JavaScript
- Size: 90.8 KB
- Stars: 22
- Watchers: 0
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Thread-reader-reader
Helps converting Twitter threads to stand-alone articles by extracting them to simple HTML. Relies on the [Thread reader](https://threadreaderapp.com) third-party app.
## Installation
1. Make sure you have Node and NPM installed.
2. Install the command globally
```
npm i -g thread-reader-reader
```
## Usage
1. Submit the first tweet of a Twitter thread to [Thread reader](https://threadreaderapp.com)
2. Get the resulting URL (Should look like https://threadreaderapp.com/thread/1241364682084093953.html)
3. Run the CLI program with the following command:
```
thread-reader-reader
```
4. The result will be written to the standard output.
Tweets will be output in `
` divs, and images and videos will be wrapped in a `` tag following the paragraph of the tweet they appear in.
### Downloading resources
By default, original image and video urls will be kept, meaning links will still use the resources stored on Twitter servers.
Instead, you can download these resources locally by adding a path to a local directory as second parameter.
```
thread-reader-reader [directory_to_store_files]
```
In that case, the urls to images and videos will be rewritten with the same path as relative url, replacing Twitter urls.
You can change this relative url by specifying a third parameter.
```
thread-reader-reader [directory_to_store_files] [relative_url_path]
```
That way, it's easy to adapt to how your destination website stores content.
### Full example
Command:
```
thread-reader-reader https://threadreaderapp.com/thread/1241364682084093953.html aquatint-files /public/images/aquatint-files > aquatint-article.html
```
Result:
- The extracted thread HTML will be written to the `aquatint-article.html` file.
- In this HTML, urls to images and videos will use `/public/images/aquatint-files` as prefix.
- Image and video files will be downloaded and stored in the `aquatint-files` directory, ready to be uploaded on your server, in the directory corresponding to `/public/images/aquatint-files`.
## As a lib
You can also use the `parser.js` file as a separate lib.
The `getTweets` function takes a DOM element as input (JSDom or real DOM will work), basically the document of a Thread Reader page and will return an array of objects:
```js
{
tweetHTML, // inner markup of the tweet text, including links
images, // array of { url } objects
videos // array of { poster, sources: [{ type, src }] } objects
}
```