Footnotes in Gatsby

Gatsby plugin using remark to generate footnotes with advanced grouping.

Installation

1npm i gatsby-remark-reference-footnotes

Use

Generate footnotes:

1[^Normal footnote]
2
3<!-- This code block gets replaced with footnotes -->
4
5```references
6
7```

Generate footnotes for a specific group of footnotes:

1[^:fig:Footnote for group named fig]
2
3<!-- This code block gets replaced with footnotes for group `fig` -->
4
5```references
6group-include: fig
7```

If you like to overwrite the global settings in place (camelCase or kebab-case):

1<!-- This code block gets replaced with footnotes -->
2
3```references
4group-include: fig
5
6inline-link-prefix: ' Fig. '
7inline-link-suffix: '.'
8inline-text-prefix: ' '
9inline-text-suffix: ''
10
11reference-link-position: end
12
13reference-link-prefix:  ' Fig. '
14reference-link-suffix:  '.⇡'
15reference-text-prefix:  ' '
16reference-text-suffix:  ''
17```

Global Configuration

Global configurations can be set in gatsby-config.js.

1module.exports = ({ root }) => ({
2  plugins: [
3    {
4      resolve: `gatsby-transformer-remark`,
5      options: {
6        plugins: [
7          {
8            resolve: `gatsby-remark-reference-footnotes`,
9            options: {
10              groupInclude: "default",
11
12              inlineLinkPrefix: "",
13              inlineLinkSuffix: "",
14              inlineTextPrefix: "",
15              inlineTextSuffix: "",
16
17              referenceLinkPosition: "start",
18
19              referenceLinkPrefix: "↑ ",
20              referenceLinkSuffix: ".",
21              referenceTextPrefix: "",
22              referenceTextSuffix: " "
23            }
24          }
25        ]
26      }
27    }
28  ]
29});

Options

group-include

string? — default: default
If a footnote reference starts with :groupname: the output can be filtered by this group-name.

reference-link-prefix

string? — default: ↑ Footnote: in link before reference number

reference-link-suffix

string? — default: . Footnote: in link after reference number

reference-text-prefix

string? — default: '' Footnote: text before reference link

reference-text-suffix

string? — default: ' ' Footnote: text after reference link

reference-link-position

string? — default: start – options: start|end Footnote-Reference: should the reference link be at the start or end

inline-link-prefix

string? — default: '' Footnote-Reference: in link before inline number

inline-link-suffix

string? — default: '' Footnote-Reference: in link after inline number

inline-text-prefix

string? — default: '' Footnote-Reference: text before inline link

inline-text-suffix

string? — default: '' Footnote-Reference: text after inline link

Example

Input

1Text with[^test] reference footnote[^test].
2Text with inline footnote[^here the inline reference].
3
4![Cat](http://placekitten.com/g/80/120)
5_This is a cat [^:fig:Reference from a different group]_
6
7<!-- refs -->
8
9[^test]: This is the named reference
10
11### Footnotes
12
13<!-- This code block gets replaced with footnotes -->
14
15```references
16
17```
18
19### Figures
20
21<!-- This code block gets replaced with footnotes -->
22
23```references
24group-include: fig
25inline-link-prefix: 'Fig. '
26reference-link-position: end
27reference-link-prefix: ' Fig. '
28reference-link-suffix: ' ⇡'
29reference-text-prefix: ' '
30```

Output

License

MIT – Stefan Huber

Version

• 0.0.4 – FIX: sorting problems