From ed7d2e879cc7ccbc805e1da5c2d8dd9a895a560c Mon Sep 17 00:00:00 2001 From: Marcos Pereira Date: Sat, 14 Oct 2023 18:06:48 -0400 Subject: [PATCH] dos: move jte-extension-api to /docs --- docs/jte-extension-api.md | 27 +++++++++++++++++++++++++++ jte-extension-api/README.md | 22 +--------------------- mkdocs.yml | 3 ++- 3 files changed, 30 insertions(+), 22 deletions(-) create mode 100644 docs/jte-extension-api.md diff --git a/docs/jte-extension-api.md b/docs/jte-extension-api.md new file mode 100644 index 00000000..49424dfd --- /dev/null +++ b/docs/jte-extension-api.md @@ -0,0 +1,27 @@ +--- +title: jte-extension-api +description: A jte module that defines the interface to add extensions to jte generation. +--- + +# jte-extension-api + +This module defines the interface to add extensions to jte generation. Extensions can generate additional files based on metadata about jte templates. + +## Writing an Extension + +Extension authors must implement the `gg.jte.extension.api.JteExtension` interface. +The implementing class must have a no-argument constructor so that it can be instantiated by name. + +## Testing + +The companion module `jte-extension-api-mocks` provides mock implementations of the API interfaces to help with writing unit tests. + +## Usage + +The jte Maven and Gradle plugins allow configuring extensions. + +## Examples + +* [jte-models](jte-models.md) module is an extension that generates typesafe facades for templates. +* [test/jte-runtime-cp-test-models](https://github.com/casid/jte/tree/{{ POM_VERSION }}/test/jte-runtime-cp-test-models) uses the Maven plugin to apply the jte-models extension. +* [test/jte-runtime-cp-test-models-gradle](https://github.com/casid/jte/tree/{{ POM_VERSION }}/test/jte-runtime-cp-test-models-gradle) uses the Gradle plugin to apply the jte-models extension. \ No newline at end of file diff --git a/jte-extension-api/README.md b/jte-extension-api/README.md index a4fce736..efd386aa 100644 --- a/jte-extension-api/README.md +++ b/jte-extension-api/README.md @@ -1,23 +1,3 @@ # jte-extension-api -This module defines the interface to add extensions to jte generation. -Extensions can generate additional files based on metadata about jte templates. - -## Writing an Extension - -Extension authors must implement the `JteExtension` interface. -The implementing class must have a no-argument constructor so that it can be instantiated by name. - -## Testing - -The companion module jte-extension-api-mocks provides mock implementations of the API interfaces to help with writing unit tests. - -## Usage - -The jte Maven and Gradle plugins allow configuring extensions. - -## Examples - -* jte-models module is an extension that generates typesafe facades for templates. -* test/jte-runtime-cp-test-models uses the Maven plugin to apply the jte-models extension. -* test/jte-runtime-cp-test-models-gradle uses the Gradle plugin to apply the jte-models extension. \ No newline at end of file +See official docs: . diff --git a/mkdocs.yml b/mkdocs.yml index d458c56e..009eb48f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,12 +80,13 @@ nav: - "Rendering a Template": rendering-a-template.md - "Templates Syntax": syntax.md - "HTML Rendering": html-rendering.md - - "Configurations": + - "How To": - "Hot Reloading": hot-reloading.md - "Precompiling Templates": pre-compiling.md - "Binary Rendering": binary-rendering.md - "Localization": localization.md - "jte-models Facade Generator": jte-models.md + - "Extensions API": jte-extension-api.md - "Spring Boot Support": - "Spring Boot Starter 3": spring-boot-starter-3.md - "Spring Boot Starter 2": spring-boot-starter-2.md