gatsby-remark-reference-footnotes
Advanced tools
Comparing version 0.0.3 to 0.0.4
@@ -126,3 +126,3 @@ const yaml = require("js-yaml"); | ||
// sort footnotes | ||
footnotes.sort((a, b) => a.offset > b.offset); | ||
footnotes.sort((a, b) => a.offset - b.offset); | ||
@@ -229,3 +229,3 @@ // filter by identifier | ||
type: "html", | ||
value: `</div>` | ||
value: "</div>" | ||
}, | ||
@@ -232,0 +232,0 @@ markdownAST.children.slice(index + 1) |
{ | ||
"name": "gatsby-remark-reference-footnotes", | ||
"version": "0.0.3", | ||
"version": "0.0.4", | ||
"description": "gatsby remark plugin to generate footnotes", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -7,3 +7,2 @@ # Footnotes in Gatsby | ||
## Installation | ||
@@ -16,2 +15,3 @@ | ||
## Use | ||
Generate footnotes: | ||
@@ -25,2 +25,3 @@ | ||
```references | ||
``` | ||
@@ -30,2 +31,3 @@ ```` | ||
Generate footnotes for a specific group of footnotes: | ||
````md | ||
@@ -64,2 +66,3 @@ [^:fig:Footnote for group named fig] | ||
## Global Configuration | ||
Global configurations can be set in `gatsby-config.js`. | ||
@@ -77,26 +80,26 @@ | ||
options: { | ||
groupInclude: 'default', | ||
groupInclude: "default", | ||
inlineLinkPrefix: '', | ||
inlineLinkSuffix: '', | ||
inlineTextPrefix: '', | ||
inlineTextSuffix: '', | ||
inlineLinkPrefix: "", | ||
inlineLinkSuffix: "", | ||
inlineTextPrefix: "", | ||
inlineTextSuffix: "", | ||
referenceLinkPosition: 'start', | ||
referenceLinkPosition: "start", | ||
referenceLinkPrefix: '↑ ', | ||
referenceLinkSuffix: '.', | ||
referenceTextPrefix: '', | ||
referenceTextSuffix: ' ' | ||
}, | ||
referenceLinkPrefix: "↑ ", | ||
referenceLinkSuffix: ".", | ||
referenceTextPrefix: "", | ||
referenceTextSuffix: " " | ||
} | ||
} | ||
], | ||
}, | ||
}, | ||
], | ||
}) | ||
] | ||
} | ||
} | ||
] | ||
}); | ||
``` | ||
## Options | ||
## Options | ||
### `group-include` | ||
@@ -107,7 +110,6 @@ | ||
### `reference-link-prefix` | ||
`string?` — default: `↑ ` | ||
*Footnote:* in link before reference number | ||
`string?` — default: `↑` | ||
_Footnote:_ in link before reference number | ||
@@ -117,3 +119,3 @@ ### `reference-link-suffix` | ||
`string?` — default: `.` | ||
*Footnote:* in link after reference number | ||
_Footnote:_ in link after reference number | ||
@@ -123,3 +125,3 @@ ### `reference-text-prefix` | ||
`string?` — default: `''` | ||
*Footnote:* text before reference link | ||
_Footnote:_ text before reference link | ||
@@ -129,3 +131,3 @@ ### `reference-text-suffix` | ||
`string?` — default: `' '` | ||
*Footnote:* text after reference link | ||
_Footnote:_ text after reference link | ||
@@ -135,3 +137,3 @@ ### `reference-link-position` | ||
`string?` — default: `start` – options: `start`|`end` | ||
*Footnote-Reference:* should the reference link be at the `start` or `end` | ||
_Footnote-Reference:_ should the reference link be at the `start` or `end` | ||
@@ -141,3 +143,3 @@ ### `inline-link-prefix` | ||
`string?` — default: `''` | ||
*Footnote-Reference:* in link before inline number | ||
_Footnote-Reference:_ in link before inline number | ||
@@ -147,3 +149,3 @@ ### `inline-link-suffix` | ||
`string?` — default: `''` | ||
*Footnote-Reference:* in link after inline number | ||
_Footnote-Reference:_ in link after inline number | ||
@@ -153,3 +155,3 @@ ### `inline-text-prefix` | ||
`string?` — default: `''` | ||
*Footnote-Reference:* text before inline link | ||
_Footnote-Reference:_ text before inline link | ||
@@ -159,6 +161,4 @@ ### `inline-text-suffix` | ||
`string?` — default: `''` | ||
*Footnote-Reference:* text after inline link | ||
_Footnote-Reference:_ text after inline link | ||
## Example | ||
@@ -173,14 +173,18 @@ | ||
![Cat](http://placekitten.com/g/80/120) | ||
*This is a cat [^:fig:Reference from a different group]* | ||
_This is a cat [^:fig:Reference from a different group]_ | ||
<!-- refs --> | ||
[^test]: This is the named reference | ||
### Footnotes | ||
<!-- This code block gets replaced with footnotes --> | ||
```references | ||
``` | ||
### Figures | ||
<!-- This code block gets replaced with footnotes --> | ||
@@ -199,2 +203,3 @@ | ||
### Output | ||
![example output](./example/doc.png) | ||
@@ -208,3 +213,2 @@ | ||
[gatsby]: https://www.gatsbyjs.org/ | ||
@@ -216,1 +220,5 @@ [remark]: https://github.com/remarkjs/remark | ||
[author]: http://signalwerk.ch/ | ||
## Version | ||
- **0.0.4** – FIX: sorting problems |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Native code
Supply chain riskContains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.
Found 1 instance in 1 package
206
0
11992
3