craft-hub / PluginDocumentPreview

Interface: PluginDocumentPreview

Defined in: packages/craft-hub/src/marketplace.ts:299

Safely rendered source document for one exact plugin package version.

Properties

document

document: ProjectReadme

Defined in: packages/craft-hub/src/marketplace.ts:305

---

manifest

manifest: object

Defined in: packages/craft-hub/src/marketplace.ts:304

contributes

contributes: object

contributes.commandPresets

commandPresets: object[]

contributes.commands

commands: object[]

contributes.commandTemplates

commandTemplates: object[]

contributes.integrations

integrations: object[]

contributes.navigationPanels

navigationPanels: object[]

contributes.packageLinks

packageLinks: object[]

contributes.packageQuickActions

packageQuickActions: object[]

contributes.packageToolGroups

packageToolGroups: object[]

contributes.projectTemplates

projectTemplates: object[]

contributes.skills

skills: object[]

contributes.workbenches

workbenches: object[]

craftHub

craftHub: object

craftHub.minVersion?

optional minVersion?: string

description?

optional description?: string

displayName

displayName: string

icon?

optional icon?: string

id

id: string

includesPlugins

includesPlugins: object[]

links?

optional links?: object

links.documentation?

optional documentation?: string

links.feedback?

optional feedback?: string

links.homepage?

optional homepage?: string

links.repository?

optional repository?: string

localizations?

optional localizations?: Record<string, { description?: string; displayName?: string; permissionReasons?: Record<string, string>; }>

maintainers?

optional maintainers?: object[]

permissionReasons?

optional permissionReasons?: Record<string, string>

permissions

permissions: ("local-read" | "local-write" | "remote-read" | "remote-write" | "commands" | "command-presets" | "read-project-files" | "read-user-settings")[]

projectFiles

projectFiles: string[]

requiresPlugins

requiresPlugins: object[]

schemaVersion

schemaVersion: 1

slug?

optional slug?: string

---

origin

origin: "local" | "marketplace"

Defined in: packages/craft-hub/src/marketplace.ts:303

---

package

package: string

Defined in: packages/craft-hub/src/marketplace.ts:300

---

sourceId

sourceId: string

Defined in: packages/craft-hub/src/marketplace.ts:302

---

version

version: string

Defined in: packages/craft-hub/src/marketplace.ts:301