@pumpkin-plugins/docs API / packages / PackageRow

Interface: PackageRow

Defined in: tools/docs/src/packages.ts:4

One row of the package tables in the root README.

Properties

description

description: string

Defined in: tools/docs/src/packages.ts:10

One-line description.

---

dir

dir: string

Defined in: tools/docs/src/packages.ts:6

Folder relative to the repo root, such as packages/my-plugin.

---

license

license: string

Defined in: tools/docs/src/packages.ts:12

License identifier from package.json.

---

licenseFile?

optional licenseFile?: string

Defined in: tools/docs/src/packages.ts:14

Package-specific license file relative to the repo root, when present.

---

name

name: string

Defined in: tools/docs/src/packages.ts:8

Name shown as the link text.