Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement Markdown tables support (GFM extension) #735

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Implement Markdown tables support (GFM extension) #735

wants to merge 10 commits into from

Conversation

rock3r
Copy link
Collaborator

@rock3r rock3r commented Dec 19, 2024

This PR adds support for the GFM tables extension in the Markdown renderer. At a high level:

  • It creates the SimpleTableLayout (see its kdoc)
  • It creates GitHubTableProcessorExtension and GitHubTableRendererExtension
    • The former uses commonmark-ext-gfm-tables to parse the table markup
    • The latter renders it
  • It simplifies and improves the Markdown extensions API by opening a couple properties of the MarkdownProcessor and adding an experimental + operator to it, for extensions
  • Updates the Markdown readme mentioning the table extension
  • Adds a readme for the table extension (see it for details)
  • ImageOptim's the images in art/docs

rock3r and others added 10 commits December 19, 2024 16:49
@rock3r
Implement BasicTableLayout, use it in the Markdown renderer
0f0d0d4 
BasicTableLayout is a simple table layout that lives in foundation. It
does not have styling (that'll be implemented in the ui layer) but does
all we need for Markdown, and other similar basic scenarios. It is not
lazy and its performances can surely be improved, but it works.
@rock3r
Create GfmTableStyle and use it in Markdown
ec5028e
@rock3r
Cleanup code pre-PR
9480053
@rock3r
Move BasicTableLayout into foundation.layout package
bf7881c
@rock3r
Simplify MarkdownProcessor extensions API
1f84c3b 
By making the MarkdownProcessor's extensions and CommonMark Parser
properties public, they are now accessible to extensions directly from
the processor itself, eliminating the need to pass them explicitly.

This, in turn, makes it possible to implement more complex extensions as
stateless objects, instead of stateful classes, further simplifying the
implementation and usage of extensions.
@rock3r
Improve KDocs and add experimental plus API
7a15b6c 
Add an experimental operator fun plus(extension) to MarkdownProcessor
and MarkdownBlockRenderer that allows users to easily create a copy of
either with an additional extension, if they need to.
@rock3r
Update Markdown readme
acb7ca1 
We now have tables :)

Also make the image in there local, and pass ImageOptim on the other
pics in art/docs for good measure (and faster loading).
@rock3r
Add GFM-tables readme
869e29e
@rock3r
Happy
fff27cd
@rock3r
Make BasicTableLayout not use subcomposition
405b2e6 
It's completely unnecessary for our needs.
@rock3r rock3r added new component A new component to implement markdown This issue impacts the Markdown rendering subsystem labels Dec 19, 2024
@rock3r rock3r requested a review from hamen December 19, 2024 16:38
@rock3r rock3r self-assigned this Dec 19, 2024
@rock3r rock3r linked an issue Dec 20, 2024 that may be closed by this pull request
Implement non-lazy table component #471
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hamen hamen hamen approved these changes

Assignees

@rock3r rock3r

Labels
markdown This issue impacts the Markdown rendering subsystem new component A new component to implement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement non-lazy table component
2 participants
@rock3r @hamen