DOVENV

Appearance

@dovenv/theme-banda - API documentation ​

Functions ​

bandaTheme() ​

ts
function bandaTheme(opts?: Config): Config

Banda theme configuration for dovenv.

This function takes an optional object with keys matching the plugin names and values that are the respective plugin's configuration objects.

Parameters ​

ParameterTypeDescription
opts?ConfigOptional configuration options.

Returns ​

Config

The dovenv configuration object.

Example ​

ts
import { bandaTheme } from '@dovenv/theme-banda'

export default bandaTheme( {
  lint: { commitlint: { gitmoji: true } },
  docs: {
      input: 'README.md',
      output: 'build/README.md',
  },
} )

mergeConfig() ​

ts
function mergeConfig(...config: (Config | Config[])[]): Config

Merges multiple banda-theme configuration objects into a single configuration.

Parameters ​

ParameterType
...config(Config | Config[])[]

Returns ​

Config

Type Aliases ​

Config ​

ts
type Config: {
  convert: Config;
  docs: DocsPluginConfig;
  examples: Config;
  lint: Config;
  repo: Parameters<typeof default>[0];
  templates: Config;
  todo: Config;
  workspace: Config;
};

Type declaration ​

NameTypeDescription
convert?ConfigConvert configuration. See - https://dovenv.pigeonposse.com/guide/plugin/convert - https://www.npmjs.com/package/@dovenv/convert
docs?DocsPluginConfigDocumentation configuration. See - https://dovenv.pigeonposse.com/guide/plugin/docs - https://www.npmjs.com/package/@dovenv/docs
examples?ConfigExamples configuration. See - https://dovenv.pigeonposse.com/guide/plugin/examples - https://www.npmjs.com/package/@dovenv/examples
lint?ConfigLint configuration. See - https://dovenv.pigeonposse.com/guide/plugin/lint - https://www.npmjs.com/package/@dovenv/lint
repo?Parameters<typeof default>[0]Repository configuration. See - https://dovenv.pigeonposse.com/guide/plugin/repo - https://www.npmjs.com/package/@dovenv/repo
templates?ConfigTemplates configuration. See - https://dovenv.pigeonposse.com/guide/plugin/templates - https://www.npmjs.com/package/@dovenv/templates
todo?ConfigTo-Do configuration. See - https://dovenv.pigeonposse.com/guide/plugin/todo - https://www.npmjs.com/package/@dovenv/todo
workspace?ConfigWorkspace configuration. See - https://dovenv.pigeonposse.com/guide/plugin/workspace - https://www.npmjs.com/package/@dovenv/workspace

References ​

default ​

Renames and re-exports bandaTheme

Namespaces ​