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 (254 forks)batch import
docshelp wanted

Repository metrics

Stars
 (3,456 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the current highlighting setup in docs/layouts/template.html and implement one of the suggested solutions: switch to a highlighting engine that supports Nearley, write a highlight.js plugin, or patch the template to interpret 'ne' as 'js'.
Tech stack
javascripthtml
Domain
documentationweb dev
Issue type
Bug
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptHTML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70