Skip to content

Commit b1c1296

Browse files
authored
docs(json-schema): set markdownDescription for rich-text editor previews (#41894)
Editors such as VSCode will look for `markdownDescription` to render the description, if present, and will render that as Markdown, instead of plain text.
1 parent dc1cf8a commit b1c1296

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

tools/docs/schema.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ function createSingleConfig(option: RenovateOptions): Record<string, unknown> {
5555
} & Omit<Partial<RenovateOptions>, 'type'> = {};
5656
if (option.description) {
5757
temp.description = option.description;
58+
temp.markdownDescription = option.description;
5859
}
5960
temp.type = option.type;
6061
if (option.type === 'array') {

0 commit comments

Comments
 (0)