Skip to content

feat(template-engine): add NRG#1236

Open
andriishin wants to merge 1 commit intoakullpp:masterfrom
andriishin:add-nrg
Open

feat(template-engine): add NRG#1236
andriishin wants to merge 1 commit intoakullpp:masterfrom
andriishin:add-nrg

Conversation

@andriishin
Copy link
Copy Markdown

Adds NRG (Nanolaba Readme Generator) to the Template Engine section, alphabetized between Jtwig and Pebble.

Why it qualifies

Per CONTRIBUTING.md criteria:

  • (c) Absolutely unique in its approach and function — every existing entry in Template Engine (Freemarker, Handlebars.java, Jamal, jstachio, jte, Jtwig, Pebble, Rocker, StringTemplate, Thymeleaf) is a general-purpose engine targeting HTML, source code or arbitrary text. NRG is the only entry purpose-built for Markdown documentation, with first-class support for generating multiple language variants (e.g. README.md and README.ru.md) from a single .src.md source — neither use case is covered by the existing entries.
  • (d) Niche product that fills a gap — there is currently no Java tool in this list that targets multi-language README/documentation generation.

Distinguishing features (per PR rule 1)

  • Multi-language output from a single template via ${en:'…', ru:'…'} substitution.
  • File imports, custom widgets, and a built-in table-of-contents widget.
  • Distributed as CLI, Maven plugin (com.nanolaba:nrg-maven-plugin), and Java library — covers both ad-hoc and build-pipeline use cases.

Compliance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant