Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFence

Represents a fence.
Fences are used to omit section of a build_include replacement from being processed.
Thus the fenced section is included verbatium unless options are set to explicity exclude fences from output.

Hierarchy

Implemented by

Index

Properties

Properties

end

end: string | RegExp

End of Fence.
Can be string value such as:

"```"

--or-- regular expression such as

/^```(?:(?:$)|(?:[\r\n]+))/  

remove

remove: boolean

Boolean value to determine if fences should be removed from output.
If set to true then fenced sections will be excluded from output.

start

start: string | RegExp

Start of Fence.
Can be string value such as:

"```"

--or-- regular expression such as

/^```(?:([a-zA-Z]+)?(?:[\r\n]+))(?:[\s\S]+?)/  

type

type: fenceKind

The type of fencing to apply.
Can be any fenceKind such as strict

Generated using TypeDoc