feat(README): add readme
This commit is contained in:
1 parent
b119bba0d5
commit
c2f256e488
1 file changed
+155
@@ -0,0 +1,155 @@
|
||||
# meshero website
|
||||
|
||||
Site statique généré avec [Hugo](https://gohugo.io/).
|
||||
Le thème est intégré au projet sous forme de **submodule Git** (`themes/mon-theme`).
|
||||
|
||||
## Prérequis
|
||||
|
||||
- [Git](https://git-scm.com/)
|
||||
- [Hugo](https://gohugo.io/installation/) (version *extended* recommandée, selon le thème)
|
||||
|
||||
Vérifier les installations :
|
||||
|
||||
```bash
|
||||
git --version
|
||||
hugo version
|
||||
```
|
||||
|
||||
## Cloner le projet
|
||||
|
||||
Le thème étant un submodule, il faut le récupérer en même temps que le dépôt.
|
||||
|
||||
### Option 1 : en une commande (recommandé)
|
||||
|
||||
```bash
|
||||
git clone --recurse-submodules https://git.cyberjinh.fr/anael/meshero.git
|
||||
cd mon-projet
|
||||
```
|
||||
|
||||
### Option 2 : si le dépôt a été cloné sans les submodules
|
||||
|
||||
Le dossier `themes/hextra` est alors vide. Pour le récupérer :
|
||||
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## Lancer le site en local
|
||||
|
||||
```bash
|
||||
hugo server
|
||||
```
|
||||
|
||||
Le site est accessible sur <http://localhost:1313>. Il se recharge automatiquement à chaque modification.
|
||||
|
||||
Pour inclure les brouillons :
|
||||
|
||||
```bash
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
## Générer le site (build)
|
||||
|
||||
```bash
|
||||
hugo build --cleanDestinationDir --gc --minify
|
||||
```
|
||||
|
||||
Le site est généré dans le dossier `public/` (non versionné).
|
||||
|
||||
## Structure du projet
|
||||
|
||||
```
|
||||
.
|
||||
├── archetypes/ # Modèles de nouveaux contenus
|
||||
├── assets/ # Fichiers traités par Hugo Pipes (SCSS, JS...)
|
||||
├── content/ # Contenu du site (Markdown)
|
||||
├── data/ # Données (YAML, JSON, TOML)
|
||||
├── layouts/ # Surcharges de templates du thème
|
||||
├── static/ # Fichiers copiés tels quels (images, favicon...)
|
||||
├── themes/
|
||||
│ └── mon-theme/ # Thème (submodule Git)
|
||||
└── hugo.toml # Configuration du site
|
||||
```
|
||||
|
||||
## Pousser des modifications
|
||||
|
||||
### 1. Vérifier l'état
|
||||
|
||||
```bash
|
||||
git status
|
||||
git diff
|
||||
```
|
||||
|
||||
### 2. Ajouter et commiter
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Description claire de la modification"
|
||||
```
|
||||
|
||||
### 3. Récupérer les changements distants (si plusieurs contributeurs)
|
||||
|
||||
```bash
|
||||
git pull --rebase origin main
|
||||
```
|
||||
|
||||
### 4. Pousser
|
||||
|
||||
```bash
|
||||
git push origin main
|
||||
```
|
||||
|
||||
> Pour travailler sur une branche séparée :
|
||||
>
|
||||
> ```bash
|
||||
> git switch -c ma-branche
|
||||
> # ... modifications, add, commit ...
|
||||
> git push -u origin ma-branche
|
||||
> ```
|
||||
|
||||
## Gérer le thème (submodule)
|
||||
|
||||
### Mettre à jour le thème vers sa dernière version
|
||||
|
||||
```bash
|
||||
git submodule update --remote --merge themes/mon-theme
|
||||
git add themes/mon-theme
|
||||
git commit -m "Mise à jour du thème"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
> Git ne stocke que le **commit** du thème pointé, pas son contenu : la mise à jour doit donc être commitée dans ce dépôt.
|
||||
|
||||
### Récupérer une mise à jour du thème faite par quelqu'un d'autre
|
||||
|
||||
Après un `git pull`, si la référence du submodule a changé :
|
||||
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
### Personnaliser le thème sans le modifier
|
||||
|
||||
Ne modifiez pas les fichiers dans `themes/mon-theme/` (les changements ne seraient pas poussés avec ce dépôt).
|
||||
Copiez plutôt le fichier à modifier dans le dossier `layouts/` du projet en conservant la même arborescence : Hugo utilisera cette version à la place de celle du thème.
|
||||
|
||||
Exemple :
|
||||
|
||||
```bash
|
||||
mkdir -p layouts/partials
|
||||
cp themes/mon-theme/layouts/partials/footer.html layouts/partials/footer.html
|
||||
```
|
||||
|
||||
## Commandes utiles
|
||||
|
||||
| Action | Commande |
|
||||
|---|---|
|
||||
| Créer une page | `hugo new content posts/mon-article.md` |
|
||||
| Serveur local | `hugo server` |
|
||||
| Build de production | `hugo --minify` |
|
||||
| Statut des submodules | `git submodule status` |
|
||||
| Historique | `git log --oneline --graph` |
|
||||
|
||||
## Licence
|
||||
|
||||
CC-0
|
||||
Reference in new issue
Block a user