TurndownService Constructor

Syntax

var turndownService = new TurndownService([options])
// or
var turndownService = TurndownService([options])

Description

Creates a new instance of TurndownService with optional configuration. The constructor can be called with or without the new keyword.

Parameters

object

Configuration object to customize the conversion behavior

Show properties

string

default:"setext"

Style for headings: setext or atx

string

default:"* * *"

Markdown representation for horizontal rules

string

default:"*"

Character for bullet list items: *, -, or +

string

default:"indented"

Style for code blocks: indented or fenced

string

default:"```"

Fence characters for code blocks: ``` or ~~~

string

default:"_"

Delimiter for emphasis: _ or *

string

default:"**"

Delimiter for strong emphasis: ** or __

string

default:"inlined"

Style for links: inlined or referenced

string

default:"full"

Style for link references: full, collapsed, or shortcut

string

default:" "

Markdown representation for line breaks

boolean

default:"false"

Whether to preserve whitespace in code blocks

function

Custom replacement function for blank elements

function

Custom replacement function for kept elements

function

Custom replacement function for unrecognized elements

Returns

TurndownService

A new TurndownService instance configured with the provided options

Examples

Basic Usage

var TurndownService = require('turndown')
var turndownService = new TurndownService()

With Options

var turndownService = new TurndownService({
  headingStyle: 'atx',
  codeBlockStyle: 'fenced',
  bulletListMarker: '-'
})

Without `new` Keyword

var turndownService = TurndownService({ emDelimiter: '*' })

Notes

The constructor automatically returns a new instance even if called without the new keyword
All options have sensible defaults based on CommonMark specification
Options can be accessed later via turndownService.options

​Syntax

​Description

​Parameters

​Returns

​Examples

​Basic Usage

​With Options

​Without new Keyword

​Notes

Syntax

Description

Parameters

Returns

Examples

Basic Usage

With Options

Without `new` Keyword

Notes