git / git/git.github.io

Some more enhancements to Prism based syntax highlighting

Open
#862 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
373
Forks
325
Avg merge
4d 18h
Merged PRs (30d)
1

Description

Right now the bundled Prism file to support syntax highlighting (cf. #490) supports these: markup (covering html, xml, svg, mathml, ssml, atom, rss), CSS, C-like, JavaScript (js), C, C++ (cpp), Bash (sh, shell), Diff, Git, Go, JSON (webmanifest), Makefile, Perl, Python (py), Ruby (rb), and YAML (yml).

The following plugins are also bundled Autoloader and File Highlight.

I think we might be able to strip the supported languages significantly to only those that are used in the repository. This would reduce the bundle download size.

A few other things to check:

  • It seems the Prism header from the artifact downloaded from the website has been removed. I think we can retain that.
  • We might need to check if it is possible to achieve the same syntax highlight in the e-mail version of the newsletter @mjaix

cc @Amrit-raj50

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

Inspect the bundled Prism artifact and identify which supported languages are actually used in the repository. Check whether the Prism header can be retained and whether equivalent syntax highlighting works in the e-mail version of the newsletter; done means the bundle is smaller without losing the required highlighting or header.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html, javascript
Domain
frontend, performance
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.