Consider use Prism instead of highlight.js

Open
#3,003 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

No source file or test is named in the issue. Start by locating the current highlight.js integration in the JavaScript code and reviewing the seven-comment discussion, then compare Prism's loading and extension behavior. Done means the project uses Prism for syntax highlighting with the expected language support and extensions, without regressions.

Written by the indexing model from the issue text.

Description

refactoring

Prism has:

  • arguably better syntax highlighting
  • much simpler language loading
  • scope for some nice extensions.

Syntax highlighting comparison (color schemes are slightly different):

Highlight.js Prism
image image
image image
image image
image image
image image
image image
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from speced/respec

All issues in speced/respec

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.