0.2.0 • Published 4 years ago
md-tweet-embed v0.2.0
md-tweet-embed
Convert Tweets to Markdown embeds.
Installation
npm install --save md-tweet-embed
# or
yarn add md-tweet-embed
Usage
From a JavaScript file, run through Node.js
const { mdTweetEmbed } = require('md-tweet-embed');
mdTweetEmbed(['https://twitter.com/hugo__df/status/1314635351928041472'])
.then(([markdownEmbed]) => {
console.log(markdownEmbed);
// > md-tweet-embed: an npm module/CLI that takes tweet URLs and turns them to markdown
// >
// > CLI: npx md-tweet-embed <your-twitter-urls>
// >
// > From JS:
// >
// > const {mdTweetEmbed} = require('md-tweet-embed');
// > mdTweetEmbed(['twitter-url']).then(([embed]) => {}); [pic.twitter.com/2A7hCismd1](https://t.co/2A7hCismd1)
// >
// > — Hugo (@hugo\_\_df) [October 9, 2020](https://twitter.com/hugo__df/status/1314635351928041472?ref_src=twsrc%5Etfw)
});
As a CLI:
npx md-tweet-embed https://twitter.com/hugo__df/status/1314635351928041472
> md-tweet-embed: an npm module/CLI that takes tweet URLs and turns them to markdown
>
> CLI: npx md-tweet-embed <your-twitter-urls>
>
> From JS:
>
> const {mdTweetEmbed} = require('md-tweet-embed');
> mdTweetEmbed(['twitter-url']).then(([embed]) => {}); [pic.twitter.com/2A7hCismd1](https://t.co/2A7hCismd1)
>
> — Hugo (@hugo\_\_df) [October 9, 2020](https://twitter.com/hugo__df/status/1314635351928041472?ref_src=twsrc%5Etfw)
Requirements
- Node 10
- Yarn 1.x or npm
Setup
- Clone the repository
- Run
yarn
ornpm install
installs all required dependencies.
npm scripts
Equivalent
npm run <script>
should also work
yarn lint
will lint all of the files with xoyarn format
will run lint with--fix
option on all the examples files (and tests).
LICENSE
Code is licensed under the MIT License.