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 (6,247 stars) (1,159 forks)batch import
area:doctoolgood first issueitype:enhancement

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

Tech stack
java
Domain
documentation
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala basicsfamiliarity with flexmarkmarkdown syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is to add support for GitHub flavoured markdown tables in the documentation tool. The tool already uses flexmark for markdown rendering, and there is a standard flexmark extension for tables. The change likely involves adding the extension to the flexmark processor configuration. Look at the documentation tool's markdown processing code (e.g., in the doc tool module) and add the TablesExtension. The extension class is com.vladsch.flexmark.ext.tables.TablesExtension. Update the builder to include it. Test locally and ensure tables render correctly.