Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

resources, not resource for path #41886

Merged
merged 2 commits into from
Jul 22, 2024
Merged

resources, not resource for path #41886

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8dfd70
resources, not resource for path
maxandersen Jul 14, 2024
1738a41
Some refinements for qute.adoc
gsmet Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/src/main/asciidoc/qute.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@
The solution is located in the `qute-quickstart` link:{quickstarts-tree-url}/qute-quickstart[directory].

[[serving-templates]]
== Serving Qute templates via http
== Serving Qute templates via HTTP

Check warning on line 30 in docs/src/main/asciidoc/qute.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/qute.adoc", "range": {"start": {"line": 30, "column": 27}}}, "severity": "WARNING"}

If you want to serve your templates via http:
If you want to serve your templates via HTTP:

Check warning on line 32 in docs/src/main/asciidoc/qute.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/qute.adoc", "range": {"start": {"line": 32, "column": 37}}}, "severity": "WARNING"}

1. The Qute Web extension allows you to directly serve via http templates located in `src/main/resource/templates/pub/`. In that case you don't need any Java code to "plug" the template, for example, the template `src/main/resource/templates/pub/foo.html` will be served from the paths `/foo` and `/foo.html` by default.
1. The Qute Web extension allows you to directly serve via HTTP templates located in `src/main/resources/templates/pub/`. In that case you don't need any Java code to "plug" the template, for example, the template `src/main/resources/templates/pub/foo.html` will be served from the paths `/foo` and `/foo.html` by default.

Check warning on line 34 in docs/src/main/asciidoc/qute.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/qute.adoc", "range": {"start": {"line": 34, "column": 56}}}, "severity": "WARNING"}
2. For finer control, you can combine it with Quarkus REST to control how your template will be served. All files located in the `src/main/resources/templates` directory and its subdirectories are registered as templates and can be injected in a REST resource.

Check warning on line 35 in docs/src/main/asciidoc/qute.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/qute.adoc", "range": {"start": {"line": 35, "column": 209}}}, "severity": "INFO"}

[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
.pom.xml
Expand All @@ -49,9 +49,9 @@
implementation("io.quarkiverse.qute.web:quarkus-qute-web")
----

NOTE: The Qute Web extension while using the quarkiverse group-id, it is still part of the Quarkus platform.
NOTE: The Qute Web extension, while hosted in the Quarkiverse, is part of the Quarkus Platform and its version is defined in the Quarkus Platform BOM.

[[hello-qute-web]]

Check warning on line 54 in docs/src/main/asciidoc/qute.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Serving Hello World with Qute'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Serving Hello World with Qute'.", "location": {"path": "docs/src/main/asciidoc/qute.adoc", "range": {"start": {"line": 54, "column": 13}}}, "severity": "INFO"}
=== Serving Hello World with Qute

Let's start with a Hello World template:
Expand All @@ -63,9 +63,9 @@
----
<1> `{http:param('name', 'Quarkus')}` is an expression that is evaluated when the template is rendered (Quarkus is the default value).

NOTE: Templates located in the `pub` directory are served via HTTP. Automatically, no controllers needed. For example, the template src/main/resource/templates/pub/foo.html will be served from the paths /foo and /foo.html by default.
NOTE: Templates located in the `pub` directory are served via HTTP. This behavior is built-in, no controllers are needed. For example, the template `src/main/resources/templates/pub/foo.html` will be served from the paths `/foo` and `/foo.html` by default.

Check warning on line 66 in docs/src/main/asciidoc/qute.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/qute.adoc", "range": {"start": {"line": 66, "column": 48}}}, "severity": "WARNING"}

If your application is running, you can open your browser and hit: http://localhost:8080/hello?name=Martin
If your application is running, you can open your browser and hit: http://localhost:8080/hello?name=Martin

For more information about Qute Web options, see the https://docs.quarkiverse.io/quarkus-qute-web/dev/index.html[Qute Web guide].

Expand Down