ratatui/ratzilla

Add support for markdown links in paragraphs

Open

#6 opened on Jan 6, 2025

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Rust (65 forks)auto 404
featurehelp wanted

Repository metrics

Stars
 (1,410 stars)
PR merge metrics
 (PR metrics pending)

Description

Support clickable markdown links within paragraphs. Use regex to detect markdown link syntax ([text](url)) in paragraph content and render them as HTML tags with appropriate attributes. Links should be styled to match the classic underline design.

Ideas/Features:

  • Detect and render markdown links as clickable elements.
  • Ensure accessibility attributes like aria-label are added for screen readers.
  • Add test cases to verify proper detection and rendering of links.

Contributor guide

Research direction
Examine the current paragraph rendering code in ratzilla, identify where text content is processed, and implement a regex based markdown link parser to convert `[text](url)` into clickable `<a>` elements. Ensure ARIA attributes are added for accessibility and write tests for various cases.
Tech stack
rust
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustRatatui
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60