From ede426a806536de20cfcb2160fba30d8011f2b51 Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Fri, 28 Jun 2019 16:57:25 -0300 Subject: [PATCH] Document markdown-enabled manifest fields. (#11426) Markdown support for rendering plugin settings in the system console is inconsistent. Let's start by at least documenting where it is supported. --- model/manifest.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/model/manifest.go b/model/manifest.go index cc918357f7..0eb64534a0 100644 --- a/model/manifest.go +++ b/model/manifest.go @@ -52,7 +52,7 @@ type PluginSetting struct { // "username" will result in a text setting that will autocomplete to a username. Type string `json:"type" yaml:"type"` - // The help text to display to the user. + // The help text to display to the user. Supports Markdown formatting. HelpText string `json:"help_text" yaml:"help_text"` // The help text to display alongside the "Regenerate" button for settings of the "generated" type. @@ -70,10 +70,10 @@ type PluginSetting struct { } type PluginSettingsSchema struct { - // Optional text to display above the settings. + // Optional text to display above the settings. Supports Markdown formatting. Header string `json:"header" yaml:"header"` - // Optional text to display below the settings. + // Optional text to display below the settings. Supports Markdown formatting. Footer string `json:"footer" yaml:"footer"` // A list of setting definitions.