-
Notifications
You must be signed in to change notification settings - Fork 116
Description
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
- feat(gui): Add Markdown Support for Descriptions #3716 implements the library-based approach using angular-markdown-editor and increases yarn.lock by ~700 lines.
-
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:
example for preview
Impact / Priority
(P2)Medium – useful enhancement
Affected Area
No response