diff --git a/subjects/README.md b/subjects/README.md new file mode 100644 index 000000000..1ac0fb6f4 --- /dev/null +++ b/subjects/README.md @@ -0,0 +1,21 @@ +### Format with Prettier + +In order to have a consistent formatting for the markdown files, we use Prettier with the default settings. + +### How to install + +In VS Code, click on the extensions icon, and type Prettier. It should be the first result of the search. Click on install. + +![](install-prettier.png) + +### Usage + +After installing it, one way of using it is to right click the view of the file you want to format and click on format document. If you have other formatters/linters installed, you will be prompted to select which one you want to use. + +![](format-document-prettier.png) + +An alternative way is to press `ctrl + shift + i`, but this might vary depending on your local settings. + +When the document is formatted, you should be able to see the Prettier text with the double tick on the bottom right corner of your window as in the image. If you only see one, another way to run it is by clicking on the `Prettier` text. + +![](double-tick-prettier.png) diff --git a/subjects/double-tick-prettier.png b/subjects/double-tick-prettier.png new file mode 100644 index 000000000..4ba8abc00 Binary files /dev/null and b/subjects/double-tick-prettier.png differ diff --git a/subjects/format-document-prettier.png b/subjects/format-document-prettier.png new file mode 100644 index 000000000..faafed1f3 Binary files /dev/null and b/subjects/format-document-prettier.png differ diff --git a/subjects/install-prettier.png b/subjects/install-prettier.png new file mode 100644 index 000000000..8aff90258 Binary files /dev/null and b/subjects/install-prettier.png differ