doc: add notes about static pages generation in documentation (closes #6)

This commit is contained in:
Corentin 2024-05-21 01:29:08 +02:00
parent aa39dc791a
commit e438103906
1 changed files with 40 additions and 1 deletions

View File

@ -2,8 +2,47 @@
The repository contains the Frog Collective website implementation. The repository contains the Frog Collective website implementation.
## Developper guidelines ## Quickstart
To generate the website, use nox :
```bash
nox -s build
```
The website is generated in the build directory.
## Editor Documentation
The content of the website is stored in the "Content" directory.
### Adding news
News can be added by adding a markdown file in the content/news directory. Name
them with english-formatted date so that they are sorted chronologically in the
rendered website. The title is defined in the metadatas, in the field 'title',
the body of the news is the markdown document :
```markdown
---
title: Your news title
---
Mardown content for the news
```
Date used for the news is the date the file was created in git.
## Developper Documentation
### HTML generation
We use https://git.collectivit.org/collectivit/jean-website 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 We use the BEM naming convention with the scheme
```css ```css