Skip to content

Update README.md #4829

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

Merged
merged 5 commits into from
Apr 4, 2018
Merged

Update README.md #4829

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d6ae0b
Update README.md
arsdehnel Apr 4, 2018
2954def
Update README.md
KyleAMathews Apr 4, 2018
bf90978
Update README.md
KyleAMathews Apr 4, 2018
106ae87
Update README.md
KyleAMathews Apr 4, 2018
6a9f520
Update README.md
KyleAMathews Apr 4, 2018
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
20 changes: 12 additions & 8 deletions packages/gatsby-remark-autolink-headers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# gatsby-remark-autolink-headers

Adds GitHub-style links to `MarkdownRemark` headers.
Adds GitHub-style hover links to headers in your markdown files when they're rendered.

This is a sub-plugin for `gatsby-transformer-remark`. As demoed below, add this plugin to the options of `gatsby-transformer-remark`.

## Install

Expand All @@ -10,12 +12,14 @@ Adds GitHub-style links to `MarkdownRemark` headers.

```javascript
// In your gatsby-config.js
plugins: [
{
resolve: `gatsby-transformer-remark`,
options: {
plugins: [`gatsby-remark-autolink-headers`],
module.exports = {
plugins: [
{
resolve: `gatsby-transformer-remark`,
options: {
plugins: [`gatsby-remark-autolink-headers`],
},
},
},
];
],
}
```