Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Task: 3rd party grammar template repository

See original GitHub issue

Copying in content from @tajmone at https://github.com/highlightjs/highlightjs-alan/issues/5#issuecomment-789643133

I think it would make sense if you created a repository template for custom HLJS syntaxes, which developers can use to create the codebase for their new languages.

GitHub Docs » Creating a template repository

The template would provide a boilerplate, with all the required files and directories structure (a sample language to use as a reference), repository settings (.giattributes, .gitignore, .editroconfig, etc.) and a sample README.md with instructions, which end users will only need to adapt to their new language (instructions for the developer, but also those for end users, as for this Issue).

This would simplify creating new languages for both newbies and experts alike, for with a single click they’d have a robust starting point, and newbies will also find the needed instructions.

At least, this is what I do when I’m dealing with commonly shared repository settings and structures, to avoid useless and repetitive tasks.

Furthermore, having an officially sanctioned template would dispel any confusion regarding the proper repository structure to adopt, since not all independent syntax repos are abiding to the same structure right now.

Issue Analytics

State:
Created 3 years ago
Comments:28 (28 by maintainers)

Top GitHub Comments

1reaction

jf990commented, Mar 20, 2021

I reviewed a few other template repos, it seems a lot are using README to explain how the template works and also including a BLANK_README.md file with placeholder text for the intended user to alter to suit their project. It is documented for the user to delete README, update BLANK_README and then rename BLANK_README to README. I’m going with this for the next update.

1reaction

jf990commented, Mar 5, 2021

@joshgoebel

based on my work on other language contributions and the 3rd party quick start, I’d like to put forward this proposal

https://github.com/jf990/highlightjs-language-template

Top Results From Across the Web

Textmate grammar for template expressions #571 - GitHub

The language service extension now provides a Textmate grammar for the Angular template syntax (#483), and describes template expressions ...

ToCT: A task ontology to manage complex templates

These grammar-infused templates have wide domain applicability, since the constituents of the simple template should, theoretically, be able to ...

Documentation Style Guide - GitLab Docs

Documentation Style Guide. This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more.

Support for template expressions in repository and container ...

With this update, we included support for template expressions in repository and container resource definitions.

US6584464B1 - Grammar template query system - Google Patents

Once the user selects a template question, information server 50 uses AE to generate ... performance of tasks via distribution using third-party sites....