scala/scala3

doc tool - support GitHub flavoured markdown table

Open

#19,525 opened on Jan 24, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Scala (1,159 forks)batch import
area:doctoolgood first issueitype:enhancement

Repository metrics

Stars
 (6,247 stars)
PR merge metrics
 (Avg merge 18d 14h) (133 merged PRs in 30d)

Description

see here https://slinc.hammons.fr/docs/docs/reference/usage.html

there is already a standard extension for flexmark (which we use to render the markdown) so this would be a few lines change.

Contributor guide

Research direction
Add the flexmark tables extension to the doc tool's markdown rendering configuration. Refer to the flexmark Java wiki for the extension setup.
Tech stack
scala
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
ScalaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90