@pumpkin-plugins/docs API / info / ConfigOptionInfo

Interface: ConfigOptionInfo

Defined in: tools/docs/src/info.ts:53

One setting of the plugin's config file, as a row of the README table.

Properties

default?

optional default?: string

Defined in: tools/docs/src/info.ts:58

Shown as written; omit for options without a default.

---

key

key: string

Defined in: tools/docs/src/info.ts:55

Dotted TOML key, e.g. web.port.