Parameters
opts – An optional object of type Project2MDOptions.
Options
| Option | Type | Default | Description | |
|---|---|---|---|---|
input |
string |
'./' |
Path to the input directory to convert. | |
output |
string |
'output.md' |
Path of the Markdown file to create. | |
onprogress |
(progress: { index: number; relPath: string }) => void |
() => {} |
Callback called after each file is processed. | |
onEnd |
(summary: { total: number }) => void |
() => {} |
Callback called when processing finishes. | |
filenameFormatter |
`(relPath: string, stats: fs.Stats) => string | Promise |
Returns Markdown header for each file. Default: ###### \${relPath}`` |
Allows customizing the header of each file block. |
summaryFormatter |
`(files: { relPath: string; size: number }[]) => string | Promise |
Generates the summary table at the end. | |
exclude |
string[] |
SimpleExclude.Node |
List of files or directories to exclude (supports globs * and ?). |
|
ignoreHidden |
boolean |
true |
Skip hidden files and directories starting with .. |
|
concurrency |
number |
5 |
Maximum number of files to process concurrently. | |
maxFileSize |
number |
10 * 1024 * 1024 |
Skip files larger than this size (in bytes). | |
stopOnError |
boolean |
false |
If true, stops processing on the first error. |