Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

remark-renumber-references

remark-renumber-references

Table of contents

Type Aliases

Functions

Type Aliases

Options

Ƭ Options: Object

Options type for the remark-renumber-references plugin.

Type declaration

Name Type Description
preserveAlphanumericDefinitions? boolean If true, alphanumeric definition ids (i.e. any id that cannot be parsed into an integer) will be spared during the renumbering. If false, all definition ids will be deleted and recreated starting from [1]. Default ts true

Defined in

packages/remark-renumber-references/src/index.ts:16

Functions

default

default(this, ...parameters): undefined | void | Transformer<Root, Root>

A remark plugin that takes a Root node as input and returns the same node with all reference-style link nodes and their definition nodes renumbered in ascending order starting from [1].

Links are assigned a numeric reference id as they are encountered.

Parameters

Name Type
this Processor<undefined, undefined, undefined, undefined, undefined>
...parameters [options: Options] | void[]

Returns

undefined | void | Transformer<Root, Root>

Defined in

node_modules/unified/lib/index.d.ts:946