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.

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

Mockup for how custom classes in remark could work #1736

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions packages/gatsby-transformer-remark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ This plugin adds additional fields to the `MarkdownRemark`
GraphQL type including `html`, `excerpt`, `headers`, etc. Other Gatsby
plugins can also add additional fields.

## Adding custom classes
You can also add custom classes to elements. This is especially useful for custom positioning of images, for example right-aligning:
```markdown
![Octocat](octocat.gif "This is Octocat"){.img .img--right}
```

This will result in the following:
```html
<img class="img img--right" src="octocat.gif" alt="Octocat" title="This is Octocat" />
```

## How to query

A sample GraphQL query to get MarkdownRemark nodes:
Expand Down