Compare commits
2 Commits
9607ba8e5d
...
daaf65a7c2
| Author | SHA1 | Date |
|---|---|---|
|
|
daaf65a7c2 | |
|
|
6e5c008347 |
26
README.md
26
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 <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
|
||||
```
|
||||
|
|
|
|||
|
|
@ -10,6 +10,5 @@
|
|||
{{ social_link('Twitch', 'twitch-fill.svg', 'https://www.twitch.tv/frogcollective') }}
|
||||
{{ social_link('Mastodon', 'mastodon-fill.svg', 'https://mastodon.social/@frogcollective') }}
|
||||
{{ social_link('Bluesky', 'bluesky-fill.svg', 'https://bsky.app/profile/frogcollective.bsky.social') }}
|
||||
{{ social_link('Instagram', 'instagram-fill.svg', 'https://www.instagram.com/frogcogames/') }}
|
||||
{{ social_link('Twitter - X', 'twitter-x-line.svg', 'https://x.com/FrogCoGames') }}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue