kach/nearley

Syntax highlight Nearley grammars on the website

Open

#351 aberto em 13 de fev. de 2018

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (254 forks)batch import
docshelp wanted

Métricas do repositório

Stars
 (3.456 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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?)

Guia do colaborador

Direção de pesquisa
Revise a configuração atual de destaque em docs/layouts/template.html e implemente uma das soluções sugeridas: mudar para um mecanismo de destaque que suporte Nearley, escrever um plugin para highlight.js, ou modificar o template para interpretar 'ne' como 'js'.
Pilha de tecnologia
javascripthtml
Domain
documentationweb dev
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScriptHTML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70