Skip to content

Improve description with markdown support #4209

@xuang7

Description

@xuang7

Feature Summary

Currently, the dataset description is stored as a plain string (VARCHAR(512) NOT NULL). This makes it difficult to present richer information such as structured metadata for the datasets, links, or formatted notes (sections, bullet points, tables). Adding Markdown support would enable more informative descriptions, improve page usability, and be reusable across multiple parts of the UI (dataset and workflow descriptions).

Proposed Solution or Design

Render descriptions as Markdown on dataset detail pages, and provide a Markdown editor UI for dataset owners.

There are two approaches for the editor:

  • Library-based editor (e.g., angular-markdown-editor, or another editor wrapped in Angular): richer features, but adds dependencies and may introduce CSS conflicts

  • Native <textarea> + ngx-markdown: no new dependencies and works well in ng-zorro modals, but the toolbar is template-based and less feature-rich.

Editor example:

Image

example for preview

Image

Impact / Priority

(P2)Medium – useful enhancement

Affected Area

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    triagePending for triaging

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions