https://github.com/jbake-org/jbake-forge-addon
JBake Forge Addon
https://github.com/jbake-org/jbake-forge-addon
Last synced: 8 months ago
JSON representation
JBake Forge Addon
- Host: GitHub
- URL: https://github.com/jbake-org/jbake-forge-addon
- Owner: jbake-org
- License: apache-2.0
- Created: 2013-09-15T18:22:52.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-05-28T13:06:47.000Z (over 10 years ago)
- Last Synced: 2025-05-07T04:47:14.793Z (8 months ago)
- Language: Java
- Homepage:
- Size: 883 KB
- Stars: 3
- Watchers: 3
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.asciidoc
- License: LICENSE
Awesome Lists containing this project
README
== JBoss Forge Addon for JBake
:idprefix: id_
This is a project to provide JBoss Forge Add-on for JBake project.
Currently this project is in-development.
=== Dependencies: None (or)
=== Depends on
[options="header"]
|===
|Addon |Exported |Optional
|DEP1
|yes
|no
|DEP2
|yes
|yes
|===
== Setup
This Addon requires the following installation steps.
=== Add configuration to pom.xml
To use this addon, you must add it as a dependency in the *pom.xml* of your `forge-addon` classified artifact:
(Make sure the dependency is put all the way to the left, and uses 3 spaces for indentation of GAV)
[source,xml]
----
org.jbake.forge.addon
jbake-addon
forge-addon
${version}
----
== Features
ABCFactory for simple ABC blah::
Allows for blah blah
+
[source,java]
----
@Inject private ABCFactory factory;
ABC abc = factory.createABC();
----
+
[TIP]
====
If your addon uses a container that does not support "@Inject" annotations, services such as the `ABCFactory` may also be
accessed via the `AddonRegistry`:
----
Imported imported = addonRegistry.getServices(ABCFactory.class);
ABCFactory factory = imported.get();
----
====
Creating a new XYZ instance::
Causes XYZ to occur
+
[source,java]
----
XYZ xyz = factory.createXYZ();
----