Skip to content

PromptScript API


Interface: MarkdownSkillConfig

Defined in: formatters/src/markdown-instruction-formatter.ts:29

Configuration for a markdown-based skill file.

Properties

argumentHint?

optional argumentHint?: string

Defined in: formatters/src/markdown-instruction-formatter.ts:35

Optional argument hint


content

content: string

Defined in: formatters/src/markdown-instruction-formatter.ts:37

Skill content/instructions


description

description: string

Defined in: formatters/src/markdown-instruction-formatter.ts:33

Description


examples?

optional examples?: object[]

Defined in: formatters/src/markdown-instruction-formatter.ts:50

Pre-extracted examples from the skill's nested examples property

description?

optional description?: string

input

input: string

name

name: string

output

output: string


license?

optional license?: string

Defined in: formatters/src/markdown-instruction-formatter.ts:48

License identifier from SKILL.md frontmatter


name

name: string

Defined in: formatters/src/markdown-instruction-formatter.ts:31

Skill name


outputDir?

optional outputDir?: string

Defined in: formatters/src/markdown-instruction-formatter.ts:55

Relative output directory underneath the target's skill folder. Overrides the default <dotDir>/skills/<name> layout when provided.


rawFrontmatter?

optional rawFrontmatter?: string

Defined in: formatters/src/markdown-instruction-formatter.ts:46

Raw frontmatter from source SKILL.md for pass-through


resources?

optional resources?: object[]

Defined in: formatters/src/markdown-instruction-formatter.ts:39

Resource files to copy alongside the skill file

content

content: string

executable?

optional executable?: boolean

origin?

optional origin?: string

relativePath

relativePath: string