PrismJS / PrismJS/prism

Add support for HighlightJS grammars

Open
#3,556 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
13k
Forks
1.4k
Avg merge
15h 36m
Merged PRs (30d)
3

Description

Motivation
V2 added custom tokenizers. This allows Prism's grammar to not rely on Prism's tokenization algorithm to highlight code, which enables them to use different parser backends. HighlightJS has an extensive list of supported languages, some absent from Prism and some with more correct syntax highlighting than their Prism counterpart. It would be beneficial to our users if they were able to use HighlightJS grammars in Prism as well.

Description
Add a first part or third party wrapper around HighlightJS grammars that enable them to be used by Prism.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reading Prism's V2 custom tokenizer support and the HighlightJS grammar model described in the issue. Determine the wrapper or integration boundary needed to use HighlightJS grammars as Prism tokenizers, then define compatibility coverage and validation before implementation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.