Skip to content

Commit b357269

Browse files
committed
🎨 Format markdown docs
Signed-off-by: mathieu.brunot <[email protected]>
1 parent d67328d commit b357269

File tree

3 files changed

+36
-25
lines changed

3 files changed

+36
-25
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,19 @@
1111
1212
[![Managed with Taiga.io](https://img.shields.io/badge/Managed%20with-TAIGA.io-709f14.svg)](https://tree.taiga.io/project/monogrammbot-monogrammjhipster-template/ "Managed with Taiga.io")
1313
-->
14+
1415
<!--
1516
[TODO] If project uses Travis-CI:
1617
1718
[![Build Status](https://travis-ci.org/Monogramm/jhipster-template.svg)](https://travis-ci.org/Monogramm/jhipster-template)
1819
-->
20+
1921
<!--
2022
[TODO] If project uses Coveralls for code coverage:
2123
2224
[![Coverage Status](https://coveralls.io/repos/github/Monogramm/jhipster-template/badge.svg?branch=master)](https://coveralls.io/github/Monogramm/jhipster-template?branch=master)
2325
-->
26+
2427
<!--
2528
[TODO] If project is deployed to DockerHub:
2629
@@ -29,6 +32,7 @@
2932
[![Docker Version](https://images.microbadger.com/badges/version/monogramm/jhipster-template.svg)](https://microbadger.com/images/monogramm/jhipster-template)
3033
[![Docker Size](https://images.microbadger.com/badges/image/monogramm/jhipster-template.svg)](https://microbadger.com/images/monogramm/jhipster-template)
3134
-->
35+
3236
<!--
3337
[TODO] If project is deployed to Heroku:
3438
@@ -105,7 +109,7 @@ To ensure everything worked, run:
105109
java -jar target/*.jar
106110
```
107111

108-
Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
112+
Then navigate to <http://localhost:8080> in your browser.
109113

110114
<!--
111115
[TODO] If project is deployed to Heroku:
@@ -137,7 +141,7 @@ Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
137141

138142
**Monogramm**
139143

140-
- Website: https://www.monogramm.io
144+
- Website: <https://www.monogramm.io>
141145
- Github: [@Monogramm](https://github.com/Monogramm)
142146

143147
## :handshake: Contributing

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
This directory contains the code for the **JHipster template** docs site, [monogramm.github.io/jhipster-template](https://monogramm.github.io/jhipster-template).
44

55
References:
6-
* [Publish Your Project Documentation with GitHub Pages](https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/)
6+
7+
- [Publish Your Project Documentation with GitHub Pages](https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/)
78

89
## Contributing
910

1011
For information about contributing, see the [Contributing page](https://github.com/Monogramm/jhipster-template/blob/master/CONTRIBUTING.md).
11-

docs/jhipster.md

+28-21
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# JHipster template
22

3-
This application was generated using JHipster 6.4.1, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v6.4.1](https://www.jhipster.tech/documentation-archive/v6.4.1).
3+
This application was generated using JHipster 6.4.1, you can find documentation and help at <https://www.jhipster.tech/documentation-archive/v6.4.1>.
44

55
## Development
66

77
Before you can build this project, you must install and configure the following dependencies on your machine:
88

9-
1. [Node.js][]: We use Node to run a development web server and build the project.
10-
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
9+
1. [Node.js][]: We use Node to run a development web server and build the project.
10+
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
1111

1212
After installing Node, you should be able to run the following command to install development tools.
1313
You will only need to run this command when dependencies change in [package.json](package.json).
@@ -32,7 +32,7 @@ The `npm run` command will list all of the scripts available to run for this pro
3232

3333
Service workers are commented by default, to enable them please uncomment the following code.
3434

35-
- The service worker registering script in index.html
35+
- The service worker registering script in index.html
3636

3737
```html
3838
<script>
@@ -59,15 +59,11 @@ To benefit from TypeScript type definitions from [DefinitelyTyped][] repository
5959
Then you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:
6060
Edit [src/main/webapp/app/main.ts](src/main/webapp/app/main.ts) file:
6161

62-
```
63-
import 'leaflet/dist/leaflet.js';
64-
```
62+
import 'leaflet/dist/leaflet.js';
6563

6664
Edit [src/main/webapp/content/scss/vendor.scss](src/main/webapp/content/scss/vendor.scss) file:
6765

68-
```
69-
@import '~leaflet/dist/leaflet.scss';
70-
```
66+
@import '~leaflet/dist/leaflet.scss';
7167

7268
Note: there are still few other things remaining to do for Leaflet that we won't detail here.
7369

@@ -96,7 +92,7 @@ To ensure everything worked, run:
9692

9793
java -jar target/*.jar
9894

99-
Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
95+
Then navigate to <http://localhost:8080> in your browser.
10096

10197
Refer to [Using JHipster in production][] for more details.
10298

@@ -120,24 +116,18 @@ For more information, refer to the [Running tests page][].
120116

121117
### Code quality
122118

123-
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
119+
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on <http://localhost:9001>) with:
124120

125-
```
126-
docker-compose -f src/main/docker/sonar.yml up -d
127-
```
121+
docker-compose -f src/main/docker/sonar.yml up -d
128122

129123
You can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) or by using the maven plugin.
130124
Then, run a Sonar analysis:
131125

132-
```
133-
./mvnw -Pprod clean verify sonar:sonar
134-
```
126+
./mvnw -Pprod clean verify sonar:sonar
135127

136128
If you need to re-run the Sonar phase, please be sure to specify at least the `initialize` phase since Sonar properties are loaded from the sonar-project.properties file.
137129

138-
```
139-
./mvnw initialize sonar:sonar
140-
```
130+
./mvnw initialize sonar:sonar
141131

142132
or
143133
For more information, refer to the [Code quality page][].
@@ -163,20 +153,37 @@ For more information refer to [Using Docker and Docker-Compose][], this page als
163153
To configure CI for your project, run the ci-cd sub-generator (`jhipster ci-cd`), this will let you generate configuration files for a number of Continuous Integration systems. Consult the [Setting up Continuous Integration][] page for more information.
164154

165155
[jhipster homepage and latest documentation]: https://www.jhipster.tech
156+
166157
[jhipster 6.4.1 archive]: https://www.jhipster.tech/documentation-archive/v6.4.1
158+
167159
[using jhipster in development]: https://www.jhipster.tech/documentation-archive/v6.4.1/development/
160+
168161
[using docker and docker-compose]: https://www.jhipster.tech/documentation-archive/v6.4.1/docker-compose
162+
169163
[using jhipster in production]: https://www.jhipster.tech/documentation-archive/v6.4.1/production/
164+
170165
[running tests page]: https://www.jhipster.tech/documentation-archive/v6.4.1/running-tests/
166+
171167
[code quality page]: https://www.jhipster.tech/documentation-archive/v6.4.1/code-quality/
168+
172169
[setting up continuous integration]: https://www.jhipster.tech/documentation-archive/v6.4.1/setting-up-ci/
170+
173171
[node.js]: https://nodejs.org/
172+
174173
[yarn]: https://yarnpkg.org/
174+
175175
[webpack]: https://webpack.github.io/
176+
176177
[vue cli]: https://cli.vuejs.org/
178+
177179
[browsersync]: https://www.browsersync.io/
180+
178181
[jest]: https://facebook.github.io/jest/
182+
179183
[jasmine]: https://jasmine.github.io/2.0/introduction.html
184+
180185
[protractor]: https://www.protractortest.org/
186+
181187
[leaflet]: https://leafletjs.com/
188+
182189
[definitelytyped]: https://definitelytyped.org/

0 commit comments

Comments
 (0)