From 6e5c00834789ac5ce942e80fdc8942da29ab72e0 Mon Sep 17 00:00:00 2001 From: Adrien Allard Date: Tue, 15 Jul 2025 11:06:12 +0200 Subject: [PATCH] docs: update documentation with the list of nox commands available --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ff1e44..602bb39 100644 --- a/README.md +++ b/README.md @@ -43,25 +43,45 @@ Date used for the news is the date the file was created in git. ### HTML generation -We use https://git.frog-collective.com/collectivit/jean-web to generate the +We use to generate the website. Jinja2 templates are stored in the src directory, and use the content loaded from the 'content' folder to generate static pages. Content can be markdown document with metadata, or json files. ### CSS + We use the BEM naming convention with the scheme ```css .block--element__modifier ``` -See https://getbem.com/naming/ for insigths on the BEM naming convention. +See for insigths on the BEM naming convention. -We use SASS as a CSS extension language (https://sass-lang.com/). +We use SASS as a CSS extension language (). ### Dev env Install the following dependencies to be able to test the website locally: + ```sh npm install -g browser-sync ``` + +Then it's possible to start a local server using the command: + +```sh +browser-sync start --server build/ --watch +``` + +To extract localization messages: + +```sh +nox -s extract_messages +``` + +Then to compile them once localization is done: + +```sh +nox -s compile_messages +```