Skip to content

TurndownServiceOptions

Unofficial

Configuration options for TurndownService.

Import:

import type { TurndownServiceOptions } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface TurndownServiceOptions

Properties

PropertyTypeDescription
blankReplacement?TurndownServiceReplacementFunctionCustom replacement function for blank nodes.
br?stringLine break replacement string.
bulletListMarker?'-' | '*' | '+'Bullet list marker character.
codeBlockStyle?'fenced' | 'indented'Code block style.
defaultReplacement?TurndownServiceReplacementFunctionCustom default replacement function.
emDelimiter?'_' | '*'Emphasis delimiter character.
fence?'```' | '~~~'Fence delimiter string.
headingStyle?'atx' | 'setext'Heading style.
hr?stringHorizontal rule replacement string.
keepReplacement?TurndownServiceReplacementFunctionCustom replacement function for kept elements.
linkReferenceStyle?'collapsed' | 'full' | 'shortcut'Link reference style.
linkStyle?'inlined' | 'referenced'Link style.
preformattedCode?booleanWhether to use preformatted code blocks.
strongDelimiter?'__' | '**'Strong delimiter string.

Links to this page: