kach/nearley

Highlight grammars in docs

Open

#282 opened on Aug 25, 2017

View on GitHub
 (4 comments) (0 reactions) (1 assignee)JavaScript (3,456 stars) (254 forks)batch import
docsenhancementhelp wanted

Description

We should pull in @Hardmath123's syntax highlighting for use in the docs. https://github.com/github/linguist/pull/3781

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with nearley documentation setupBasic understanding of syntax highlighting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests integrating syntax highlighting from @Hardmath123's grammar (linked PR #3781 in linguist) into nearley's docs. Start by examining the existing documentation build process in the repository, likely using a tool like Jekyll or a static site generator. Then, understand how the external grammar can be imported or adapted. Check if the assignee has made progress or left comments. Since the issue is from 2017, verify if the PR or grammar is still compatible.