kach/nearley

Syntax highlight Nearley grammars on the website

Open

#351 opened on 2018年2月13日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)JavaScript (3,456 stars) (254 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.