docs: update README templates (#31861)

The README had a few inconsistencies. Use more Markdown elements and unify notation.

Use code fences and note syntax with "bash", vs indentation, default, or "sh".

Complete Markdown URLs. Some were incomplete or used an incorrect notation, i.e., "[text][]" vs.
"[text]()", note the use of parentheticals over brackets.

Add a References section and use Markdown unordered list syntax.

Review links to documentation and add where missing or update to current locations to reduce
redirects.

Fixes: #31860

Author: timothystone

generators/angular/templates/README.md.jhi.client.angular.ejs

@@ -21,28 +21,28 @@
  EJS fragments will process % delimiter tags in the template and & delimiter tags during the merge process.
 -%>
 <&_ if (fragment.customCliSection) { -&>
-[Angular CLI][] with
+[Angular CLI](https://angular.dev/tools/cli) with
 <&_ } -&>
 <&_ if (fragment.developmentSection) { -&>
 ### Using Angular CLI
 
-You can also use [Angular CLI][] to generate some custom client code.
+You can also use [Angular CLI](https://angular.dev/tools/cli) to generate some custom client code.
 
 For example, the following command:
 
-```
+```bash
 ng generate component my-component
 ```
 
 will generate few files:
 
-```
+```bash
 create <%= clientSrcDir %>app/my-component/my-component.html
 create <%= clientSrcDir %>app/my-component/my-component.ts
 update <%= clientSrcDir %>app/app.config.ts
 ```
 
 <&_ } -&>
 <&_ if (fragment.referenceSection) { _&>
-[Angular CLI]: https://angular.dev/tools/cli
+- [Angular CLI](https://angular.dev/tools/cli)
 <&_ } -&>

generators/client/templates/README.md.jhi.client.ejs

@@ -46,23 +46,23 @@ After installing Node, you should be able to run the following command to instal
 <%_ } _%>
 You will only need to run this command when dependencies change in [package.json](package.json).
 
-```
+```bash
 <%= nodePackageManagerCommand %> install
 ```
 
-We use <%- nodePackageManager %> scripts and <&- fragments.customCliSection(' ') &>[<%= clientBundlerName %>][] as our build system.
+We use <%- nodePackageManager %> scripts and <&- fragments.customCliSection(' ') &><%= clientBundlerName %> as our build system.
 
   <%_ if (locals.cacheProviderRedis || locals.cacheProviderHazelcast || locals.cacheProviderMemcached) { _%>
 If you are using <%= cacheProvider %> as a cache, you will have to launch a cache server.
 To start your cache server, run:
 
-```
+```bash
 docker compose -f src/main/docker/<%= locals.cacheProviderHazelcast ? 'hazelcast-management-center' : cacheProvider %>.yml up -d
 ```
 
     <%_ if (cacheProviderRedis) { _%>
 
-The cache can also be turned off by adding to the application yaml:
+The cache can also be turned off by adding to the `application.yml`:
 
 ```yaml
 spring:
@@ -72,15 +72,14 @@ spring:
 
 See [here](https://docs.spring.io/spring-boot/reference/io/caching.html#io.caching.provider.none) for details.
 
-**WARNING**: If you're using the second level Hibernate cache and disabling the Spring cache, you have to disable the second level Hibernate cache as well since they are using
-the same CacheManager.
+**WARNING**: If you're using the second level Hibernate cache and disabling the Spring cache, you have to disable the second level Hibernate cache as well since they are using the same CacheManager.
     <%_ } _%>
   <%_ } _%>
 
 Run the following commands in two separate terminals to create a blissful development experience where your browser
 auto-refreshes when files change on your hard drive.
 
-```
+```bash
 <%= nodePackageManagerCommand %> backend:start
 <%= nodePackageManagerCommand %> start
 ```
@@ -120,36 +119,36 @@ ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),
 
 ### Managing dependencies
 
-For example, to add [Leaflet][] library as a runtime dependency of your application, you would run the following command:
+For example, to add [Leaflet](https://leafletjs.com/) library as a runtime dependency of your application, you would run the following command:
 
-```
+```bash
 <%= nodePackageManagerCommand %> <%= clientPackageMngrAdd %> leaflet
 ```
 
-To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run the following command:
+To benefit from TypeScript type definitions from [DefinitelyTyped](https://definitelytyped.org/) repository in development, you would run the following command:
 
-```
+```bash
 <%= nodePackageManagerCommand %> <%= clientPackageMngrAddDev %> @types/leaflet
 ```
 
 Then you would import the JS and CSS files specified in library's installation instructions so that [<%= clientBundlerName %>][] knows about them:
   <%_ if (clientFrameworkAngular) { _%>
 Edit [<%= clientSrcDir %>app/app.config.ts](<%= clientSrcDir %>app/app.config.ts) file:
 
-```
+```typescript
 import 'leaflet/dist/leaflet.js';
 ```
 
 Edit [<%= clientSrcDir %>content/scss/vendor.scss](<%= clientSrcDir %>content/scss/vendor.scss) file:
 
-```
+```typescript
 @import 'leaflet/dist/leaflet.css';
 ```
 
   <%_ } _%>
 Note: There are still a few other things remaining to do for Leaflet that we won't detail here.
 
-For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].
+For further instructions on how to develop with JHipster, have a look at [Using JHipster in development](https://www.jhipster.tech/development/).
 
 <%_ if (microfrontend) { -%>
 ### Developing Microfrontend
@@ -159,7 +158,7 @@ You must start a pre-built gateway version or from source.
 
 Start gateway from source:
 
-```
+```bash
 cd gateway
 <%= nodePackageManagerCommand %> run docker:db:up # start database if necessary
 <%= nodePackageManagerCommand %> run docker:others:up # start service discovery and authentication service if necessary
@@ -169,15 +168,15 @@ cd gateway
 Microfrontend's `build-watch` script is configured to watch and compile microfrontend's sources and synchronizes with gateway's frontend.
 Start it using:
 
-```
+```bash
 cd microfrontend
 <%= nodePackageManagerCommand %> run docker:db:up # start database if necessary
 <%= nodePackageManagerCommand %> run build-watch
 ```
 
 It's possible to run microfrontend's frontend standalone using:
 
-```
+```bash
 cd microfrontend
 <%= nodePackageManagerCommand %> run docker:db:up # start database if necessary
 <%= nodePackageManagerCommand %> watch # alias for `npm start` and `npm run backend:start` in parallel
@@ -189,23 +188,23 @@ cd microfrontend
 <&_ if (fragment.testingSection) { -&>
 ### Client tests
 
-Unit tests are run by [<%= clientTestFrameworkName %>][]. They're located near components and can be run with:
+Unit tests are run by <%= clientTestFrameworkName %>. They're located near components and can be run with:
 
-```
+```bash
 <%= nodePackageManagerCommand %> test
 ```
 <&_ } -&>
 <&_ if (fragment.referenceSection) { -&>
 <%_ if (clientBundlerWebpack) { _%>
-[Webpack]: https://webpack.js.org/
+- [Webpack](https://webpack.js.org/)
 <%_ } -%>
 <%_ if (clientFrameworkReact || clientFrameworkAngular || microfrontend) { _%>
-[BrowserSync]: https://www.browsersync.io/
+- [BrowserSync](https://www.browsersync.io/)
 <%_ } -%>
 <%_ if (clientFrameworkAngular || clientFrameworkReact) { _%>
-[Jest]: https://jestjs.io
+- [Jest](https://jestjs.io)
 <%_ } -%>
-[Leaflet]: https://leafletjs.com/
-[DefinitelyTyped]: https://definitelytyped.org/
+- [Leaflet](https://leafletjs.com/)
+- [DefinitelyTyped](https://definitelytyped.org/)
 <&_ } -&>
 <&- fragments.render() -&>

generators/common/__snapshots__/generator.spec.ts.snap

@@ -140,17 +140,19 @@ This application was generated using JHipster JHIPSTER_VERSION, you can find doc
 
 
 
-[JHipster Homepage and latest documentation]: https://www.jhipster.tech/
-[JHipster JHIPSTER_VERSION archive]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION
-[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/development/
-[Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/docker-compose
-[Using JHipster in production]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/production/
-[Running tests page]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/running-tests/
-[Code quality page]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/code-quality/
-[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/setting-up-ci/
-
-[Node.js]: https://nodejs.org/
-[NPM]: https://www.npmjs.com/
+
+## References
+
+- [JHipster Homepage and latest documentation](https://www.jhipster.tech/)
+- [JHipster JHIPSTER_VERSION archive](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION)
+- [Using JHipster in development](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/development/)
+- [Using Docker and Docker-Compose](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/docker-compose)
+- [Using JHipster in production](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/production/)
+- [Running tests page](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/running-tests/)
+- [Code quality page](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/code-quality/)
+- [Setting up Continuous Integration](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/setting-up-ci/)
+- [Node.js](https://nodejs.org/)
+- [NPM](https://www.npmjs.com/)
 ",
     "stateCleared": "modified",
   },

generators/common/templates/README.md.jhi.ejs

@@ -56,24 +56,26 @@ This application was generated using JHipster <%= jhipsterVersion %>, you can fi
 
 <&- fragments.othersSection() &>
 <& } &>
-[JHipster Homepage and latest documentation]: <%= hipsterDocumentationLink %>
-[JHipster <%= jhipsterVersion %> archive]: <%= documentationArchiveUrl %>
+
+## References
+
+- [JHipster Homepage and latest documentation](<%= hipsterDocumentationLink %>)
+- [JHipster <%= jhipsterVersion %> archive](<%= documentationArchiveUrl %>)
 <%_ if (applicationTypeGateway || applicationTypeMicroservice) { _%>
-[Doing microservices with JHipster]: <%= documentationArchiveUrl %>/microservices-architecture/
+- [Doing microservices with JHipster](<%= documentationArchiveUrl %>/microservices-architecture/)
 <%_ } _%>
-[Using JHipster in development]: <%= documentationArchiveUrl %>/development/
+- [Using JHipster in development](<%= documentationArchiveUrl %>/development/)
 <%_ if (serviceDiscoveryEureka) { _%>
-[Service Discovery and Configuration with the JHipster-Registry]: <%= documentationArchiveUrl %>/microservices-architecture/#jhipster-registry
+- [Service Discovery and Configuration with the JHipster-Registry](<%= documentationArchiveUrl %>/microservices-architecture/#jhipster-registry)
 <%_ } _%>
 <%_ if (serviceDiscoveryConsul) { _%>
-[Service Discovery and Configuration with Consul]: <%= documentationArchiveUrl %>/microservices-architecture/#consul
+- [Service Discovery and Configuration with Consul](<%= documentationArchiveUrl %>/microservices-architecture/#consul)
 <%_ } _%>
-[Using Docker and Docker-Compose]: <%= documentationArchiveUrl %>/docker-compose
-[Using JHipster in production]: <%= documentationArchiveUrl %>/production/
-[Running tests page]: <%= documentationArchiveUrl %>/running-tests/
-[Code quality page]: <%= documentationArchiveUrl %>/code-quality/
-[Setting up Continuous Integration]: <%= documentationArchiveUrl %>/setting-up-ci/
-
-[Node.js]: https://nodejs.org/
-[NPM]: https://www.npmjs.com/
+- [Using Docker and Docker-Compose](<%= documentationArchiveUrl %>/docker-compose)
+- [Using JHipster in production](<%= documentationArchiveUrl %>/production/)
+- [Running tests page](<%= documentationArchiveUrl %>/running-tests/)
+- [Code quality page](<%= documentationArchiveUrl %>/code-quality/)
+- [Setting up Continuous Integration](<%= documentationArchiveUrl %>/setting-up-ci/)
+- [Node.js](https://nodejs.org/)
+- [NPM](https://www.npmjs.com/)
 <&- fragments.referenceSection() &>

generators/cypress/templates/README.md.jhi.cypress.ejs

@@ -28,7 +28,7 @@ and can be run by starting Spring Boot in one terminal (`<%= nodePackageManagerC
 
 Before running Cypress tests, it's possible to specify user credentials by overriding the `CYPRESS_E2E_USERNAME` and `CYPRESS_E2E_PASSWORD` environment variables.
 
-```
+```bash
 export CYPRESS_E2E_USERNAME="<your-username>"
 export CYPRESS_E2E_PASSWORD="<your-password>"
 ```
@@ -38,8 +38,10 @@ See Cypress documentation for setting OS [environment variables](https://docs.cy
 #### Lighthouse audits
 
 You can execute automated [Lighthouse audits](https://developer.chrome.com/docs/lighthouse/overview) with [cypress-audit](https://github.com/mfrachet/cypress-audit) by running `<%= nodePackageManagerCommand %> run e2e:cypress:audits`.
+
 You should only run the audits when your application is packaged with the production profile.
-The lighthouse report is created in `<%= cypressTemporaryDir %>lhreport.html`.
+
+The Lighthouse report is created in `<%= cypressTemporaryDir %>lhreport.html`.
 <%_ if (cypressCoverage) { _%>
 
 ### E2E Webapp Code Coverage
@@ -49,21 +51,27 @@ When using Cypress, you can generate code coverage report by running your dev se
 <%_ if (cypressCoverageWebpack) { _%>
 Build your Angular application with instrumented code:
 
-    <%= nodePackageManagerCommand %> run webapp:instrumenter
+```bash
+<%= nodePackageManagerCommand %> run webapp:instrumenter
+```
 
 <%_ } _%>
 Start your backend without compiling frontend:
 
-    <%= nodePackageManagerCommand %> run backend:start
+```bash
+<%= nodePackageManagerCommand %> run backend:start
+```
 
 Start your Cypress end to end testing:
 
-    <%= nodePackageManagerCommand %> run e2e --configuration coverage
+```bash
+<%= nodePackageManagerCommand %> run e2e --configuration coverage
+```
 
 The coverage report is generated under `<%- temporaryDir %>/cypress-coverage` folder.
 
 <%_ } _%>
 <&_ } -&>
 <&_ if (fragment.referenceSection) { -&>
-[Cypress]: https://www.cypress.io/
+- [Cypress](https://www.cypress.io/)
 <&_ } -&>

generators/java-simple-application/generators/graalvm/templates/README.md.jhi.native.ejs

@@ -26,12 +26,15 @@
 #### Installation
 
 To build a Native image, you need to install a JDK that is compatible with GraalVM. Please refer to the [GraalVM Release Notes](https://www.graalvm.org/release-notes/) and install the appropriate JDK. Using SDKMAN simplifies the installation process.
-```
+
+```bash
 sdk install java 21-graalce
 ```
+
 #### How to Build a Native Image
 
 To build a native image, execute the following command:
+
 ```bash
 npm run native-package
 # <%- packageJsonScripts['native-package'] %>
@@ -40,12 +43,14 @@ npm run native-package
 After that, set up peripheral services like PostgreSQL using `npm run services:up`(<%- packageJsonScripts['services:up'] %>) and ensure everything is ready.
 
 Lastly, run the Native image and experience its fast startup 😊.
+
 ```bash
 npm run native-start
 # <%- packageJsonScripts['native-start'] %>
 ```
 
 If you've enabled e2e testing with Cypress, you can verify its operation using the following command:
+
 ```bash
 npm run native-e2e
 # <%- packageJsonScripts['native-e2e'] %>

generators/java-simple-application/generators/openapi-generator/templates/README.md.jhi.openapi-generator.ejs

@@ -23,7 +23,7 @@
 <&_ if (fragment.developmentSection) { -&>
 ### Doing API-First development using openapi-generator-cli
 
-[OpenAPI-Generator]() is configured for this application. You can generate API code from the `src/main/resources/swagger/api.yml` definition file by running:
+[OpenAPI-Generator](https://openapi-generator.tech) is configured for this application. You can generate API code from the `src/main/resources/swagger/api.yml` definition file by running:
 <%_ if (buildToolMaven) { _%>
 ```bash
 ./mvnw generate-sources
@@ -38,11 +38,11 @@ Then implements the generated delegate classes with `@Service` classes.
 
 To edit the `api.yml` definition file, you can use a tool such as [Swagger-Editor](). Start a local instance of the swagger-editor using docker by running: `docker compose -f src/main/docker/swagger-editor.yml up -d`. The editor will then be reachable at [http://localhost:7742](http://localhost:7742).
 
-Refer to [Doing API-First development][] for more details.
+Refer to [Doing API-First development](<%= documentationArchiveUrl %>/doing-api-first-development/) for more details.
 <&_ } -&>
 
 <&_ if (fragment.referenceSection) { -&>
-[OpenAPI-Generator]: https://openapi-generator.tech
-[Swagger-Editor]: https://editor.swagger.io
-[Doing API-First development]: <%= documentationArchiveUrl %>/doing-api-first-development/
+- [OpenAPI-Generator](https://openapi-generator.tech)
+- [Swagger-Editor](https://editor.swagger.io)
+- [Doing API-First development](<%= documentationArchiveUrl %>/doing-api-first-development/)
 <&_ } -&>

generators/java/generators/gatling/templates/README.md.jhi.gatling.ejs

@@ -1,19 +1,20 @@
 <&_ if (fragment.testingSection) { -&>
 ### Gatling
 
-Performance tests are run by [Gatling][] and written in Scala. They're located in [src/test/java/gatling/simulations](src/test/java/gatling/simulations).
+Performance tests are run by [Gatling](https://gatling.io/) and written in Scala. They're located in [src/test/java/gatling/simulations](src/test/java/gatling/simulations).
 
 You can execute all Gatling tests with
-```
+
+```bash
 <%_ if (buildToolMaven) { _%>
 ./mvnw gatling:test
 <%_ } else { _%>
-./gradlew gatlingRun.
+./gradlew gatlingRun
 <%_ } _%>
 ```
 
 <&_ } -&>
 
 <&_ if (fragment.referenceSection) { -&>
-[Gatling]: https://gatling.io/
+- [Gatling](https://gatling.io/)
 <&_ } -&>