Interface: MarkdownFormatterConfig¶

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

Configuration for a markdown instruction formatter.

Properties¶

defaultConvention¶

defaultConvention: string

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

Default output convention

description¶

description: string

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

Human-readable description

dotDir¶

dotDir: string

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

Dot directory for additional files (e.g. '.opencode')

hasAgents¶

hasAgents: boolean

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

Whether this formatter supports agents

hasCommands¶

hasCommands: boolean

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

Whether this formatter supports commands

hasSkills¶

hasSkills: boolean

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

Whether this formatter supports skills

mainFileHeader¶

mainFileHeader: string

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

Main file header (e.g. '# OPENCODE.md')

name¶

name: string

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

Formatter name (e.g. 'opencode', 'gemini')

outputPath¶

outputPath: string

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

Default output file path (e.g. 'OPENCODE.md')

restrictionsTransform?¶

optional restrictionsTransform?: (s) => string

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

Transform function for restriction items

Parameters¶

s¶

string

Returns¶

string

sectionNames?¶

optional sectionNames?: Partial\<Record\<SectionNameKey, string>>

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

Custom section header names

skillFileName¶

skillFileName: string

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

Skill file name (e.g. 'SKILL.md' or 'skill.md')

skillsInMultifile?¶

optional skillsInMultifile?: boolean

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

Whether skills are included in multifile mode (default: false, only in full)