Cimbali / Cimbali/markdown-viewer

Table rendering is not liberal enough in accepting valid tables.

Open
#114 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
177
Forks
25
PR merge metrics
No merged PRs in 30d

Description

A user opened issue #83 because they thought tables were not supported. The issue was closed, instructing the user to put a final vertical bar to create a proper table.

Protocols 101: "Be liberal in what you accept. Be conservative in what you produce."

Many markdown rendering engines are more liberal in what they accept as a valid table. For example the renderer used by the fossil source code manager https://fossil-scm.org/home/doc/trunk/www/index.wiki (which is the system developed by and used by the SQLite DB community.)

This markdown-viewer would be easier to use, less confusing to those who are getting away with less conservatively formatted tables in markdown if the following two enhancements were made:

1. Do not require a closing vertical bar.
2. Do not require the horizontal line at the top to contain vertical bars.

I.E. This table should be valid:

| key | value
---------------
| first | 0

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the markdown table parsing and rendering entry points, then reproduce the example table from the issue. Check how table rows and separator lines are currently validated. Done means tables without a closing vertical bar, and separators without vertical bars, render correctly without breaking existing table syntax.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.