Skip to content

Add markdown rendering to custom scripts' description #5953

@rodvand

Description

@rodvand

NetBox version

v2.10.4

Feature type

Change to existing functionality

Proposed functionality

In custom scripts, the Meta.description on each custom script is rendered as plain text. I propose to add the template tag |render_markdown in the netbox/templates/extras/script.html and script_list.html wherever the {{ script.Meta.description }} is referenced.

Use case

Custom scripts can sometimes become a bit "big" and not so easy to understand from a user's perspective and I would like to be able to add a link to a guide in the description of the script. I see this has been suggested before in #5082 but the workaround posted in that is not working, and I can't understand that it has ever worked looking at the code.

Database changes

None

External dependencies

None

As Custom Scripts descriptions today are only plain text I can't see the addition of markdown rendering doing any harm.

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions