Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README for twitter plugin #22786

Merged
merged 4 commits into from
Apr 6, 2020
Merged

Improve README for twitter plugin #22786

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7549299
Improve README for twitter plugin
Apr 3, 2020
bae65dc
Update packages/gatsby-plugin-twitter/README.md
Apr 6, 2020
cbee495
Update packages/gatsby-plugin-twitter/README.md
Apr 6, 2020
17ae007
Update packages/gatsby-plugin-twitter/README.md
Apr 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions packages/gatsby-plugin-twitter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,22 @@
Loads the Twitter JavaScript for embedding tweets, timelines, share and follow
buttons. Lets you add tweets to markdown and in other places.

Note: when copying the embed code, just copy the blockquote section and not the
script.

## Install

`npm install --save gatsby-plugin-twitter`
```shell
npm install gatsby-plugin-twitter
```

## How to use
## Configure

```javascript
// In your gatsby-config.js
plugins: [`gatsby-plugin-twitter`]
```

## How to Use

1. Find the tweet you'd like to display on twitter
laurieontech marked this conversation as resolved.
Show resolved Hide resolved
2. In the top right-hand corner of the tweet click the carrot and select "Embed tweet"
laurieontech marked this conversation as resolved.
Show resolved Hide resolved
3. Take the code you're given and copy it into your markdown page
laurieontech marked this conversation as resolved.
Show resolved Hide resolved
> Note: when copying the embed code, copy **only** the blockquote section and not the script.