Skip to content

Task: 3rd party grammar template repository #3038

Open
@joshgoebel

Description

@joshgoebel

Copying in content from @tajmone at highlightjs/highlightjs-alan-if#5 (comment)


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.

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAn enhancement or new featuregood first issueShould be easier for first time contributorshelp welcomeCould use help from communitylanguage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions