Skip to content

Allow template parameter descriptions to be markdown #5931

Closed
@mh013370

Description

@mh013370

It'd be really nice, to enhance the workspace creation UI, to be able to use markdown in template parameter descriptions. This way, things like hyperlinks, headers, or anything else markdown, would be rendered nicely in the UI. Right now, it's straight text.

For example, a parameter in terraform could be enhanced like so:

variable "image" {
   type = string
   description = <<EOT
     # Select Workspace Image
     See the [registry](https://container.registry.blah/namespace) for options.
   EOT
   default = "container.registry.blah/namespace/image:tag"
}

Perhaps the description could be passed through a markdown processor? Longer term, it'd be nice to support list(string) variable types like is supported in coder v1, but that can be handled in a separate issue.

Here's the react code for parameter input.
https://github.com/coder/coder/blob/main/site/src/components/ParameterInput/ParameterInput.tsx

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions