Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 1.34 KB

File metadata and controls

60 lines (35 loc) · 1.34 KB

remark-ignore / start

Module: start

Table of contents

Functions

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 child nodes following an ignore command having been hidden.

In this way, nodes hidden by this plugin are unaffected by transformations from other plugins until said nodes are revealed.

Parameters

Name Type
this Processor<undefined, undefined, undefined, undefined, undefined>
...parameters void[]

Returns

undefined | void | Transformer<Root, Root>

Defined in

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


ignoreStartTransformer

ignoreStartTransformer(tree): void

A unified transformer that takes a Root node as input and returns the same node with all child nodes following an ignore command having been hidden.

Parameters

Name Type
tree Root

Returns

void

Defined in

packages/remark-ignore/src/start.ts:23