ReadmeConfig
Source: gulp.config.mjs:149
Configurations to compile and generate the Readme file.
Properties
enabled(BooleanSetting) — Generate the readme from the jsdoc comments, in build and in the readme task. False (the default) keeps a hand-written readme, or none. Independent of docs.enabled: turn on either, both, or neither.file(StringSetting) — The name of the output documentation markdown file.from(StringSetting) — Location of files to use for compiling documentation into the readme.fromEsm(ArrayableSetting) — Additional.mjsfiles to document alongsidefrom, converted on the fly since the readme generator only recognizes.jsfiles - see 'Configure including ESM files in the generated readme'. Empty by default: a project that never sets this gets exactly the readme it always did.options(ArrayableSetting) — Options for formatting the output readme.template(StringSetting) — The file which will be pre-fixed to your README.md output. When it doesn't exist, the readme holds only the generated documentation.to(StringSetting) — The directory to output the readme file in.
Type
Object.<string, Setting>