rainyan/SourceMod Cvar Docs

Automatic Markdown documentation for SourceMod plugin ConVars.

Trust Signals

name	description	required	default
cwd	Current working directory.	—	${{ github.workspace }}
code_patterns	RegEx pattern for code files to match.	—	^.*\.(sp\|inc\|SP\|INC)$
doc_patterns	RegEx pattern for documentation files to match.	—	^[Rr][Ee][Aa][Dd][Mm][Ee]\.[Mm][Dd]$
header_patterns	RegEx pattern for documentation headers to match for the location of the cvar docs placeholder.	—	([Cc]vars\|[Cc]on[Vv]ars\|[Cc]onsole [Vv]ariables)
dry_run	Whether to print the output to stdout instead of writing to file.	—	false
encoding	Encoding to use for file read/write operations.	—	utf-8
format_filename	Formatting for the code file name, with placeholder $a. This is skipped if parsing one single code file.	—	### !a!\n
format_cvarname	Formatting for the cvar name, with placeholder $a.	—	* !a!\n
format_cvarprop	Formatting for the cvar property, with placeholder $a (property name), and $b (property default value).	—	* !a!: `!b!`\n

no outputs