Skip to content

getObsidianPluginBanner

Builds the banner placed at the top of main.js.

Import:

import { getObsidianPluginBanner } from '@mnaoumov/obsidian-dev-toolkit/bundlers/obsidian-plugin-build';

Signature:

function getObsidianPluginBanner(bundlerName: string): string

Parameters:

Parameter Type Description
bundlerName string The bundler’s name, as the banner states it.

Returns: string — The banner, a block comment followed by a newline.