Skip to content

TurndownServiceOptions

Unofficial

Configuration options for TurndownService.

Import:

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

Signature:

export interface TurndownServiceOptions

Properties

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

Links to this page: