kach/nearley

Syntax highlight Nearley grammars on the website

Open

#351 建立於 2018年2月13日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)JavaScript (3,456 star) (254 fork)batch import
docshelp wanted

描述

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?)

貢獻者指南

技術棧
htmlcssjavascript
領域
documentationfrontend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic JavaScriptHTML templatinghighlight.js configuration
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.