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

Added syntax highlighting #36

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Added syntax highlighting #36

merged 1 commit into from
Nov 4, 2024

Conversation

josephlewis42
Copy link
Collaborator

Fixes #30

This PR adds syntax highlighting to our produced JS bundle. Because we're not an SPA yet I just used a document listener to call render but I'm open to other suggestions if there's a better way.

Here's the outcome with ZIM in Kiwix on the left and DevDocs on the right -- overall a pretty significant readability improvement to most of these docs:

image

Copy link

codecov bot commented Nov 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.85%. Comparing base (1fc6fc7) to head (aeea417).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   91.85%   91.85%           
=======================================
  Files           4        4           
  Lines         356      356           
  Branches       45       45           
=======================================
  Hits          327      327           
  Misses         25       25           
  Partials        4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@josephlewis42 josephlewis42 force-pushed the jl/feat/syntax-highlight branch from f41b537 to b0cf3a6 Compare November 3, 2024 04:43
@josephlewis42 josephlewis42 marked this pull request as ready for review November 3, 2024 04:47
@benoit74 benoit74 self-requested a review November 3, 2024 21:31
Copy link
Contributor

@benoit74 benoit74 left a comment

Choose a reason for hiding this comment

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

Pretty straightforward once you know how to do it! ^^

LGTM

Copy link
Contributor

@benoit74 benoit74 left a comment

Choose a reason for hiding this comment

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

Oh no, sorry, we miss the CHANGELOG.md entry

@josephlewis42 josephlewis42 force-pushed the jl/feat/syntax-highlight branch from b0cf3a6 to aeea417 Compare November 3, 2024 21:52
@josephlewis42
Copy link
Collaborator Author

Whoops! Added the CHANGELOG entry.

@benoit74 benoit74 merged commit 9604fb8 into main Nov 4, 2024
8 checks passed
@benoit74 benoit74 deleted the jl/feat/syntax-highlight branch November 4, 2024 07:50
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.

Support Syntax Highlighting
2 participants