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.