kach/nearley

Syntax highlight Nearley grammars on the website

Open

#351 opened on Feb 13, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (3,456 stars) (254 forks)batch import
docshelp wanted

Description

Since #350, nearley syntax isn't highlighted in the docs -- since we used to be (ab)using other syntaxes, such as js.

We need to do one of:

  • switch the highlighting engine to the same one that GitHub uses, which supports Nearley;
  • write a plugin for highlight.js that understands nearley syntax; or
  • patch our highlight-js integration, in docs/layouts/template.html, to interpret the ne language as something else (js perhaps?)

Contributor guide

Tech stack
htmlcssjavascript
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic JavaScriptHTML templatinghighlight.js configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue offers three approaches: switch to GitHub's highlighting engine, write a highlight.js plugin for Nearley, or patch the template file to treat 'ne' as 'js'. The template file is at docs/layouts/template.html. Check if there's existing highlight.js integration and which approach maintainers prefer. The simplest is the third option; look at how other languages are handled in that template.