crossnote
    Preparing search index...

    Interface WebviewConfig

    interface WebviewConfig {
        alwaysShowBacklinksInPreview?: boolean;
        breakOnSingleNewLine?: boolean;
        chromePath?: string;
        codeBlockTheme?: CodeBlockTheme;
        cursorLine?: number;
        d2Layout?: string;
        d2Path?: string;
        d2Sketch?: boolean;
        d2Theme?: number;
        enableCriticMarkupSyntax?: boolean;
        enableEmojiSyntax?: boolean;
        enableExtendedTableSyntax?: boolean;
        enableHTML5Embed?: boolean;
        enableLinkify?: boolean;
        enablePreviewZenMode?: boolean;
        enableScriptExecution?: boolean;
        enableTypographer?: boolean;
        enableWikiLinkSyntax?: boolean;
        frontMatterRenderingOption?: FrontMatterRenderingOption;
        globalCss?: string;
        HTML5EmbedAudioAttributes?: string;
        HTML5EmbedIsAllowedHttp?: boolean;
        HTML5EmbedUseImageSyntax?: boolean;
        HTML5EmbedUseLinkSyntax?: boolean;
        HTML5EmbedVideoAttributes?: string;
        imageFolderPath?: string;
        imageMagickPath?: string;
        imageUploader?: ImageUploader;
        includeInHeader?: string;
        isVSCode?: boolean;
        jsdelivrCdnHost?: string;
        katexConfig?: KatexOptions;
        krokiServer?: string;
        latexEngine?: string;
        markdownFileExtensions?: string[];
        markdownParser?: MarkdownParser;
        markdownYoBinaryPath?: string;
        mathBlockDelimiters?: string[][];
        mathInlineDelimiters?: string[][];
        mathjaxConfig?: JsonObject;
        mathjaxV3ScriptSrc?: string;
        mathRenderingOnlineService?: string;
        mathRenderingOption?: MathRenderingOption;
        mermaidConfig?: MermaidConfig;
        mermaidTheme?: MermaidTheme;
        pandocArguments?: string[];
        pandocMarkdownFlavor?: string;
        pandocPath?: string;
        parserConfig?: ParserConfig;
        plantumlJarPath?: string;
        plantumlServer?: string;
        previewTheme?: PreviewTheme;
        printBackground?: boolean;
        protocolsWhiteList?: string;
        puppeteerArgs?: string[];
        puppeteerWaitForTimeout?: number;
        revealjsTheme?: RevealJsTheme;
        scrollSync?: boolean;
        sourceUri?: string;
        useGitHubStylePipedLink?: boolean;
        webSequenceDiagramsApiKey?: string;
        webSequenceDiagramsServer?: string;
        wikiLinkTargetFileExtension?: string;
        wikiLinkTargetFileNameChangeCase?: WikiLinkTargetFileNameChangeCase;
        zoomLevel?: number;
    }

    Hierarchy

    Index

    Properties

    alwaysShowBacklinksInPreview? breakOnSingleNewLine? chromePath? codeBlockTheme? cursorLine? d2Layout? d2Path? d2Sketch? d2Theme? enableCriticMarkupSyntax? enableEmojiSyntax? enableExtendedTableSyntax? enableHTML5Embed? enableLinkify? enablePreviewZenMode? enableScriptExecution? enableTypographer? enableWikiLinkSyntax? frontMatterRenderingOption? globalCss? HTML5EmbedAudioAttributes? HTML5EmbedIsAllowedHttp? HTML5EmbedUseImageSyntax? HTML5EmbedUseLinkSyntax? HTML5EmbedVideoAttributes? imageFolderPath? imageMagickPath? imageUploader? includeInHeader? isVSCode? jsdelivrCdnHost? katexConfig? krokiServer? latexEngine? markdownFileExtensions? markdownParser? markdownYoBinaryPath? mathBlockDelimiters? mathInlineDelimiters? mathjaxConfig? mathjaxV3ScriptSrc? mathRenderingOnlineService? mathRenderingOption? mermaidConfig? mermaidTheme? pandocArguments? pandocMarkdownFlavor? pandocPath? parserConfig? plantumlJarPath? plantumlServer? previewTheme? printBackground? protocolsWhiteList? puppeteerArgs? puppeteerWaitForTimeout? revealjsTheme? scrollSync? sourceUri? useGitHubStylePipedLink? webSequenceDiagramsApiKey? webSequenceDiagramsServer? wikiLinkTargetFileExtension? wikiLinkTargetFileNameChangeCase? zoomLevel?

    Properties

    alwaysShowBacklinksInPreview?: boolean

    Whether to always show backlinks in preview.

    breakOnSingleNewLine?: boolean

    Whether to break on single new line.

    If set to false, then two spaces at the end of line will be required to break a line.

    true
    chromePath?: string

    The path of Chrome or Chromium.

    This is used for puppeteer to generate pdf or images.

    ''
    codeBlockTheme?: CodeBlockTheme

    The code block theme.

    auto.css

    cursorLine?: number
    d2Layout?: string

    Default layout engine for D2 diagrams.

    dagre

    d2Path?: string

    Path to the D2 executable.

    d2

    d2Sketch?: boolean

    Whether to render D2 diagrams in sketch (hand-drawn) style.

    false
    d2Theme?: number

    Default theme ID for D2 diagrams.

    0
    enableCriticMarkupSyntax?: boolean

    Whether to enable critic markup syntax.

    false
    enableEmojiSyntax?: boolean

    Whether to enable emoji syntax.

    true
    enableExtendedTableSyntax?: boolean

    Whether to enable extended table syntax.

    false
    enableHTML5Embed?: boolean

    Whether to enable HTML5 embed.

    Note: This is dangerous and should be used with caution.

    false
    enableLinkify?: boolean

    Whether to enable linkify.

    true
    enablePreviewZenMode?: boolean

    Whether to enable preview zen mode. Enable this option will hide unnecessary UI elements in preview unless your mouse is over it.

    enableScriptExecution?: boolean

    Whether to enable script execution.

    Note: This is dangerous and should be used with caution.

    false
    enableTypographer?: boolean

    Whether to enable typographer.

    false
    enableWikiLinkSyntax?: boolean

    Whether to enable wiki link syntax.

    true
    frontMatterRenderingOption?: FrontMatterRenderingOption

    The front matter rendering option.

    none

    globalCss?: string

    Global custom CSS styles.

    This will be inserted into HTML <style> tag.

    ${notebookPath}/.crossnote/style.less or ''

    HTML5EmbedAudioAttributes?: string

    The audio attributes for HTML5 embed.

    controls preload="metadata"

    HTML5EmbedIsAllowedHttp?: boolean

    Whether to allow HTTP protocol for HTML5 embed. *

    false
    HTML5EmbedUseImageSyntax?: boolean

    Whether to use image syntax for HTML5 embed.

    true
    HTML5EmbedUseLinkSyntax?: boolean

    Whether to use link syntax for HTML5 embed.

    false
    HTML5EmbedVideoAttributes?: string

    The video attributes for HTML5 embed.

    controls preload="metadata"

    imageFolderPath?: string

    The folder path for storing images.

    /assets

    imageMagickPath?: string

    The path of ImageMagick.

    This is used for converting svg to png.

    ''
    imageUploader?: ImageUploader
    includeInHeader?: string

    The content to be included in HTML <head> tag. This is useful for adding custom styles or scripts.

    isVSCode?: boolean

    Whether the current environment is VSCode.

    false
    jsdelivrCdnHost?: string

    The host of jsdelivr CDN.

    cdn.jsdelivr.net

    katexConfig?: KatexOptions

    KaTeX configuration.

    https://katex.org/docs/options.html

    Defined in ${notebookPath}/.crossnote/configs.js or { macros: {} }

    krokiServer?: string

    The Kroki server used to render diagrams.

    https://kroki.io

    latexEngine?: string

    The latex engine.

    pdflatex

    markdownFileExtensions?: string[]

    The files of extensions to be included in the notebook

    [".md", ".markdown", ".mdown", ".mkdn", ".mkd", ".rmd", ".qmd", ".mdx"]
    markdownParser?: MarkdownParser

    Markdown parser to use for rendering.

    • 'markdown-it' (default) — built-in markdown-it renderer
    • 'pandoc' — render via Pandoc (requires Pandoc installed)
    • 'markdown_yo' — render via markdown_yo (WASM or native binary)
    'markdown-it'
    markdownYoBinaryPath?: string

    Path to the markdown_yo native binary.

    When set, crossnote will invoke this binary (via stdin/stdout) instead of the bundled WASM module when markdownParser is 'markdown_yo'.

    Performance note: the native binary is faster for files under ~300 KB (roughly 6× faster than WASM due to lower per-call overhead). For very large files (>500 KB) the subprocess I/O cost may exceed the WASM render time, so WASM (the default) is preferable in those cases.

    Supports $HOME and ~ variable substitution.

    '' (use WASM)

    mathBlockDelimiters?: string[][]

    The math delimiters for block math.

    For example, [["$$", "$$"]] will render $$x$$ as block math.

    [['$$', '$$']]
    mathInlineDelimiters?: string[][]

    The math delimiters for inline math.

    For example, [["$", "$"]] will render $x$ as inline math.

    [['$', '$']]
    mathjaxConfig?: JsonObject

    MathJax configuration.

    https://docs.mathjax.org/en/latest/options/index.html

    Default: Defined in ${notebookPath}/.crossnote/configs.js or

    {
      tex: {},
      options: {},
      loader: {},
    mathjaxV3ScriptSrc?: string

    The script source for MathJax v3.

    https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

    mathRenderingOnlineService?: string

    The online math rendering service used for markdown export.

    https://latex.codecogs.com/gif.latex

    mathRenderingOption?: MathRenderingOption

    The math rendering option.

    KaTeX

    mermaidConfig?: MermaidConfig

    Mermaid configuration.

    Defined in ${notebookPath}/.crossnote/configs.js or { startOnLoad: false }

    mermaidTheme?: MermaidTheme

    The mermaid theme.

    default

    pandocArguments?: string[]

    The arguments for running the pandoc command.

    []
    pandocMarkdownFlavor?: string

    The pandoc markdown flavor.

    markdown-raw_tex+tex_math_single_backslash

    pandocPath?: string

    The path of the pandoc command.

    pandoc

    parserConfig?: ParserConfig

    Parser configuration.

    ${notebookPath}/.crossnote/parser.js or {}

    plantumlJarPath?: string

    The path of the plantuml.jar file.

    The plantuml.jar file could be downloaded from https://sourceforge.net/projects/plantuml/

    ''
    plantumlServer?: string

    The PlantUML server.

    If this is set, then plantumlJarPath will be ignored.

    You run start a plantuml server by running:

    $ docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

    ''
    previewTheme?: PreviewTheme

    The preview theme.

    github-light.css

    printBackground?: boolean

    Whether to print background for file export.

    false
    protocolsWhiteList?: string

    The protocols white list.

    http://, https://, atom://, file://, mailto:, tel:

    puppeteerArgs?: string[]

    The arguments for running puppeteer.

    []
    puppeteerWaitForTimeout?: number

    The timeout for puppeteer to wait for the page to be loaded.

    Increase the timeout if the exported file is incomplete.

    0
    revealjsTheme?: RevealJsTheme

    The reveal.js theme.

    white.css

    scrollSync?: boolean
    sourceUri?: string
    useGitHubStylePipedLink?: boolean

    Whether to use GitHub style piped link.

    • GitHub style: [[ text | link ]]
    • Wiki style: [[ link | text ]]
    false
    webSequenceDiagramsApiKey?: string

    API key for WebSequenceDiagrams. Required for wider diagram sizes.

    ''
    webSequenceDiagramsServer?: string

    The WebSequenceDiagrams server URL.

    https://www.websequencediagrams.com

    wikiLinkTargetFileExtension?: string

    The file extension for the link in wikilink if the link does not have an extension.

    '.md'
    wikiLinkTargetFileNameChangeCase?: WikiLinkTargetFileNameChangeCase

    The case for the file name in wikilink. If the value is none, then the file name will not be changed. Otherwise, the file name will be transformed to the specified case. You can read https://www.npmjs.com/package/case-anything for more details.

    zoomLevel?: number

    Settings

    Member Visibility

    On This Page

    Properties
    alwaysShowBacklinksInPreviewbreakOnSingleNewLinechromePathcodeBlockThemecursorLined2Layoutd2Pathd2Sketchd2ThemeenableCriticMarkupSyntaxenableEmojiSyntaxenableExtendedTableSyntaxenableHTML5EmbedenableLinkifyenablePreviewZenModeenableScriptExecutionenableTypographerenableWikiLinkSyntaxfrontMatterRenderingOptionglobalCssHTML5EmbedAudioAttributesHTML5EmbedIsAllowedHttpHTML5EmbedUseImageSyntaxHTML5EmbedUseLinkSyntaxHTML5EmbedVideoAttributesimageFolderPathimageMagickPathimageUploaderincludeInHeaderisVSCodejsdelivrCdnHostkatexConfigkrokiServerlatexEnginemarkdownFileExtensionsmarkdownParsermarkdownYoBinaryPathmathBlockDelimitersmathInlineDelimitersmathjaxConfigmathjaxV3ScriptSrcmathRenderingOnlineServicemathRenderingOptionmermaidConfigmermaidThemepandocArgumentspandocMarkdownFlavorpandocPathparserConfigplantumlJarPathplantumlServerpreviewThemeprintBackgroundprotocolsWhiteListpuppeteerArgspuppeteerWaitForTimeoutrevealjsThemescrollSyncsourceUriuseGitHubStylePipedLinkwebSequenceDiagramsApiKeywebSequenceDiagramsServerwikiLinkTargetFileExtensionwikiLinkTargetFileNameChangeCasezoomLevel