Macaulay2 / Macaulay2/M2

Syntax highlighting in packages

Open
#3,330 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
Macaulay2
Stars
435
Forks
297
Avg merge
4d 20h
Merged PRs (30d)
11

Description

A pretty glaring caveat of syntax highlighting is that it doesn't work for packages. Here's an example with only symbols from Core being highligted, which looks really odd.

A pretty simple solution would be to generate a prism grammar for each package in installPackage and load it in the header of html files from that package.

It would be great if the same worked for emacs.

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 the installPackage entry point and how package HTML files are generated. Trace how the HTML header currently loads syntax highlighting, then determine how package-specific grammar generation and Emacs support fit into that flow. Done means package symbols are highlighted in generated HTML and the requested highlighting also works in Emacs.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, html
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.