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.

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

Replace Pegdown with Commonmark #366

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

zbynek
Copy link
Contributor

@zbynek zbynek commented Aug 3, 2024

Pegdown is no longer maintained, which will cause problems when upgrading build pipeline to Java 17.
Also it's nice to use an implemenntation of Markdown that is compatible with GH previews and IDE plugins -- commonmark seems to do quite well.

Three differences had to be handled in this PR though:

  • code snippets are now delimited by backticks since indented snippets behaved differently in Pegdown and Commonmark.
  • Commonmark does not support typography replacements (-- to en-dash, --- to em-dash, quotes) out of the box, HTML entities can be used instead.
  • no support for special definition list MD extension (only used by DevGuideI18nMessages) -- rewritten to HTML tags

Fixes #332

@zbynek zbynek marked this pull request as draft August 3, 2024 18:34
@zbynek zbynek marked this pull request as ready for review August 31, 2024 00:27
@zbynek
Copy link
Contributor Author

zbynek commented Aug 31, 2024

@niloc132
Copy link
Member

The hosting for the link above is at https://www.gwtproject.org.vertispan.com/ - the contents from gwtproject/gwt-site-webapp#13 is also included in that build.

Copy link
Contributor

@craigmit craigmit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@niloc132
Copy link
Member

Updated to latest gwt-site-webapp main and this PR at https://www.gwtproject.org.vertispan.com/ - looking good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build the gwt-site with Maven doesn't work
3 participants