frog-collective/frog-website
frog-collective
/
frog-website
5
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

docs: update documentation with the list of nox commands available

This commit is contained in:
Adrien Allard 2025-07-15 11:06:12 +02:00
parent 9607ba8e5d
commit 6e5c008347
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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 <https://git.frog-collective.com/collectivit/jean-web> 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 <https://getbem.com/naming/> 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 (<https://sass-lang.com/>).
### 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
```