Interface: MarkdownFormatterConfig¶

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

Configuration for a markdown instruction formatter.

Properties¶

defaultConvention¶

defaultConvention: string

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

Default output convention

description¶

description: string

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

Human-readable description

dotDir¶

dotDir: string

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

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

hasAgents¶

hasAgents: boolean

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

Whether this formatter supports agents

hasCommands¶

hasCommands: boolean

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

Whether this formatter supports commands

hasSkills¶

hasSkills: boolean

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

Whether this formatter supports skills

hookAdapterTarget?¶

optional hookAdapterTarget?: "claude" | "cursor" | "factory" | "codex"

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

Hook adapter target name (default: same as formatter name)

hooksConfigPath?¶

optional hooksConfigPath?: string

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

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:104

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

mcpConfigFormat?¶

optional mcpConfigFormat?: "json" | "toml"

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

MCP config format (default: 'json')

mcpConfigPath?¶

optional mcpConfigPath?: string

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

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:96

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

outputPath¶

outputPath: string

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

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

restrictionsTransform?¶

optional restrictionsTransform?: (s) => string

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

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:118

Custom section header names

skillFileName¶

skillFileName: string

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

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

skillsInMultifile?¶

optional skillsInMultifile?: boolean

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

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