Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamessimone/gatsby-remark-footnotes
Customize your Gatsby Remark markup footnotes
https://github.com/jamessimone/gatsby-remark-footnotes
gatsby gatsby-plugin gatsby-remark gatsby-remark-plugin gatsbyjs markdown
Last synced: 3 months ago
JSON representation
Customize your Gatsby Remark markup footnotes
- Host: GitHub
- URL: https://github.com/jamessimone/gatsby-remark-footnotes
- Owner: jamessimone
- License: mit
- Created: 2019-05-03T23:28:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-24T02:52:47.000Z (over 3 years ago)
- Last Synced: 2024-10-06T11:13:43.318Z (3 months ago)
- Topics: gatsby, gatsby-plugin, gatsby-remark, gatsby-remark-plugin, gatsbyjs, markdown
- Language: JavaScript
- Size: 9.77 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Gatsby Remark Footnotes Plugin
## gatsby-remark-footnotes
[](https://www.npmjs.com/package/gatsby-remark-footnotes)
This is a Gatsby Remark plugin that aims to customize the text and style of footnotes in case you want to adhere to the Wikipedia style, `^`, front of the footnote-type link.
## Installation
With npm:
`npm install --save gatsby-remark-footnotes`
or with yarn, if that's more your style:
`yarn add gatsby-remark-footnotes`
## Example config
```javascript
// In gatsby-config.js
plugins: [
{
resolve: `gatsby-transformer-remark`,
options: {
plugins: [
{
resolve: `gatsby-remark-footnotes`,
options: {
footnoteBackRefPreviousElementDisplay: "inline",
footnoteBackRefDisplay: "inline",
footnoteBackRefInnerText: "^", // Defaults to: "↩"
//use if you want the Wikipedia style ^ link without an underline beneath it
footnoteBackRefAnchorStyle: `text-decoration: none;`,
//use "front" for Wikipedia style ^ links
footnoteBackRefInnerTextStartPosition: "front",
useFootnoteMarkerText: false, // Defaults to false
useCustomDivider: "
References:" // Defaults to
}
}
]
}
}
];
```
## Plugin Options: in-depth
`footnoteBackRefPreviousElementDisplay`: the "previous" element is _always_ a `
` tag. Change the CSS display property of it with this prop. Can be omitted if you prefer to not change the display property from the `block` default, or you have a stylesheet overriding the default already.
`footnoteBackRefDisplay`: the footnote "back ref" refers to the `` tag that can be clicked on to bring a user back to the footnote they originated from. Set both this and `footnoteBackRefPreviousElementDisplay` to `inline` to have them appear side-by-side. Can be omitted, same as above.
`footnoteBackRefInnerText`: defaults to `↩`. You can use whatever you'd like. Go nuts, replace it with a 👋!
`footnoteBackRefAnchorStyle`: As in the example above, if you use `^` you'll want to override the `text-decoration` property (and potentially other ones, like color, if that's your thing) to conform to the Wikipedia style. Can be omitted.
`footnoteBackRefInnerTextStartPosition`: `front` for Wikipedia style, otherwise can be omitted.
`useFootnoteMarkerText`: set to `true` to use footnote's "marker" (how the footnote is introduced between the Markdown brackets) as the footnote "heading" introducing the footnote in the actual footnote section. Markdown by default auto-numbers footnotes, regardless of how they are introduced; if you use a series of footnotes like so [^1] [^second] [^third] the footnotes will auto number to _1, 2, 3_ in the footnote sections. By setting this flag to `true`, the second and third footnotes would be introduced: `second.` and `third.`
`useCustomDivider`: defaults to `
`, can be replaced with HTML of the user's choosing. If set to `""` it will remove the horizontal rule.
## Targeting your footnotes with further CSS selectors
This plugin appends `class` names to the elements it produces so that you can further stylize / override the existing CSS.
- `
` tag: `footnote-paragraph` class
- `
- `` tag: `footnote-backref` class
- (if using `useFootnoteMarkerText` config option) `` tag: `footnote-marker-text` class
## Considerations
This plugin removes nodes from the AST Markdown tree that `gatsby-transformer-remark` uses to otherwise massage your markdown.
This means that _other_ functionality you might rely on from other Gatsby plugins also working on your markdown will probably not work as expected for your footnotes. E.G. you use `gatsby-external-link` - it's not going to pick up on anchor tags present in your footnotes. This plugin automatically adds `target="_blank" rel="noopener noreferrer` properties to your anchor tags.
Contributions are welcome!