gatsby-remark-reference-footnotes - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "gatsby-remark-reference-footnotes",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "gatsby remark plugin to generate footnotes",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,3 +5,3 @@ # Footnotes in Gatsby
 
-[Gatsby][gatsby] plugin using [remark][remark] to generate footnotes.
+[Gatsby][gatsby] plugin using [remark][remark] to generate footnotes with advanced grouping.
 
@@ -15,66 +15,22 @@
 
-## Options
-### `group-include`
+## Use
+Generate footnotes:
 
-`string?` — default: `default`  
-If a footnote reference starts with `:groupname:` the output can be filtered by this group-name.
+````md
+[^Normal footnote]
 
+<!-- This code block gets replaced with footnotes -->
 
-### `reference-link-prefix`
+```references
+```
+````
 
-`string?` — default: `↑ `
-*Footnote:* in link before reference number
+Generate footnotes for a specific group of footnotes:
+````md
+[^:fig:Footnote for group named fig]
 
-### `reference-link-suffix`
+<!-- This code block gets replaced with footnotes for group `fig` -->
 
-`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
-
-
-
-
-
-## Use
-Generate footnotes:
-
-````md
 ```references
-# This code block gets replaced with footnotes
+group-include: fig
 ```
@@ -86,4 +42,5 @@ ````
 ````md
+<!-- This code block gets replaced with footnotes -->
+
 ```references
-# This code block gets replaced with footnotes
 group-include: fig
@@ -140,2 +97,57 @@
 
+
+## 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
@@ -156,9 +168,11 @@
 ### Footnotes
+<!-- This code block gets replaced with footnotes -->
+
 ```references
-# gets repalced with footnotes
 ```
 
 ### Figures
+<!-- This code block gets replaced with footnotes -->
+
 ```references
-# gets repalced with footnotes
 group-include: fig
@@ -165,0 +179,0 @@ inline-link-prefix: 'Fig. '

No alert changes

Improved metrics

Total package byte prevSize

18094

increased by1.78%

Number of lines in readme file

198

increased by7.61%

No dependency changes