Skip to content

Commit 173394d

Browse files
committed
Add docs on footnote option
1 parent 030dd8d commit 173394d

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export {default} from './lib/index.js'
77
* Configuration for `remark-gfm`.
88
*
99
* Currently supports `singleTilde` as a parse option and
10-
* `tableCellPadding`, `tablePipeAlign`, and `stringLength` as
11-
* a serialization option.
10+
* `firstLineBlank`, `stringLength`, `tableCellPadding`, and `tablePipeAlign`
11+
* as serialization options.
1212
*/
1313
export interface Options extends MicromarkOptions, MdastOptions {}

readme.md

+2
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,8 @@ Configuration (TypeScript type).
219219

220220
###### Fields
221221

222+
* `firstLineBlank` (`boolean`, default: `false`)
223+
— serialize with a blank line for the first line of footnote definitions
222224
* `stringLength` (`((value: string) => number)`, default: `d => d.length`)
223225
— detect the size of table cells, used when aligning cells
224226
* `singleTilde` (`boolean`, default: `true`)

0 commit comments

Comments
 (0)