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

Add pandoc as an alternative renderer #179

Merged
merged 6 commits into from
Apr 18, 2024
Merged

Add pandoc as an alternative renderer #179

merged 6 commits into from
Apr 18, 2024

Conversation

DannyBen
Copy link
Owner

@DannyBen DannyBen commented Apr 18, 2024

Due to the fact that all semi-native Ruby libraries for markdown generation have issues and long-standing bugs, this PR adds pandoc as an alternative rendering engine. The default is still going to be Redcarpet for the time being, since pandoc requires an external installation, which is less convenient.

To use pandoc as the renderer, add this to .madness.yml:

# ./madness.yml
renderer: pandoc

Notable advantages of using pandoc:

  1. Headers that contains diacritics have their ids (for Table of Contents links) generated correctly
  2. Nested lists (3 or more levels deep) are generated correctly

Notable disadvantages of using pandoc:

  1. Requires the command pandoc to be installed (usually it is as simple as installing it with your package manager)
  2. Does not handle some less common text decorations (like ==highlight==).

@DannyBen DannyBen merged commit 554ba21 into master Apr 18, 2024
6 checks passed
@DannyBen DannyBen deleted the add/pandoc-renderer branch April 18, 2024 06:14
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.

None yet

1 participant