MarkdownFormatterConfig
Defined in: formatters/src/markdown-instruction-formatter.ts:101
Configuration for a markdown instruction formatter.
Properties
defaultConvention
defaultConvention:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:109
Default output convention
description
description:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:107
Human-readable description
dotDir
dotDir:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:113
Dot directory for additional files (e.g. ‘.opencode’)
hasAgents
hasAgents:
boolean
Defined in: formatters/src/markdown-instruction-formatter.ts:117
Whether this formatter supports agents
hasCommands
hasCommands:
boolean
Defined in: formatters/src/markdown-instruction-formatter.ts:119
Whether this formatter supports commands
hasSkills
hasSkills:
boolean
Defined in: formatters/src/markdown-instruction-formatter.ts:121
Whether this formatter supports skills
hookAdapterTarget?
optionalhookAdapterTarget?:"claude"|"cursor"|"factory"|"codex"
Defined in: formatters/src/markdown-instruction-formatter.ts:137
Hook adapter target name (default: same as formatter name)
hooksConfigPath?
optionalhooksConfigPath?:string
Defined in: formatters/src/markdown-instruction-formatter.ts:135
Hook settings file path (e.g. ‘.cursor/hooks.json’). If set,
Hooks
block is emitted to this path.
mainFileHeader
mainFileHeader:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:111
Main file header (e.g. ’# OPENCODE.md’)
mcpConfigFormat?
optionalmcpConfigFormat?:"json"|"toml"
Defined in: formatters/src/markdown-instruction-formatter.ts:133
MCP config format (default: ‘json’)
mcpConfigPath?
optionalmcpConfigPath?:string
Defined in: formatters/src/markdown-instruction-formatter.ts:131
MCP config file path (e.g. ‘.windsurf/mcp_config.json’). If set,
Mcp Servers
block is emitted to this path.
name
name:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:103
Formatter name (e.g. ‘opencode’, ‘gemini’)
outputPath
outputPath:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:105
Default output file path (e.g. ‘OPENCODE.md’)
restrictionsTransform?
optionalrestrictionsTransform?: (s) =>string
Defined in: formatters/src/markdown-instruction-formatter.ts:129
Transform function for restriction items
Parameters
s
string
Returns
string
sectionNames?
optionalsectionNames?:Partial<Record<SectionNameKey,string>>
Defined in: formatters/src/markdown-instruction-formatter.ts:127
Custom section header names
skillFileName
skillFileName:
string
Defined in: formatters/src/markdown-instruction-formatter.ts:115
Skill file name (e.g. ‘SKILL.md’ or ‘skill.md’)
skillsDir?
optionalskillsDir?:string
Defined in: formatters/src/markdown-instruction-formatter.ts:125
Skill directory override (default: <dotDir>/skills)
skillsInMultifile?
optionalskillsInMultifile?:boolean
Defined in: formatters/src/markdown-instruction-formatter.ts:123
Whether skills are included in multifile mode (default: false, only in full)
unsupportedBlocks?
optionalunsupportedBlocks?: readonlystring[]
Defined in: formatters/src/markdown-instruction-formatter.ts:139
PromptScript blocks omitted by this target with compatibility warnings.