Création ou modification d'un article
Si tu remarques une erreur dans un article, une faute d'orthographe ou une imprécision technique, n'hésite pas à contribuer à la qualité de ce blog.
Si tu as une idée d'article et que tu souhaites l'ajouter sur ce blog, d'abord merci beaucoup :)
Voici une aide pour mener à bien ta réalisation d'article :
Les bases du Markdown
Les articles sont écrits en markdown, voici une aide pour en connaitre les bases nécessaires :
# Titre H1 (ne pas utiliser pour les articles)
## Titre H2
### Titre H3
#### Titre H4
**texte en gras**
_texte en italique_
```php
code en PHP
```
- élément liste
- deuxième élément liste
- élément sous-liste
> message un peu plus discret (en gris)
[lien vers Google](https://google.com)
Le lien de l'image peut-être relatif (image dans le dossier du projet) ou absolue (image sur internet)
Plus d'informations : https://docs.zettlr.com/fr/reference/markdown-basics/
Si vous souhaitez mettre des emojis dans votre article (recommandé) : https://getemoji.com/
Un article sur GauCode Blog
Un article sur ce blog, est représenté par un dossier, dans le dossier public/articles/{categorie}, à la racine du projet.
Le nom de ce dossier représente le "slug" (sont identifiant, qui sera dans l'URL de la page de l'article)
Le nom du dossier ne doit donc pas contenir d'espaces ni d'accents, les espaces sont remplacés par des tirets "-"
Dans ce dossier, 5 fichiers obligatoires (sauf l'image) :
- author.md contient le nom/pseudo de l'auteur de l'article
- title.md contient le titre de l'article
- subtitle.md contient le sous-titre de l'article
- content.md contient le contenu de l'article
- banner.jpg contient l'image de l'article, si le fichier n'existe pas, ça prend l'image de la categorie de l'article (DW par exemple).
Pour l'image de l'article, il faut que cette image soit libre de droits, vous pouvez par exemple la récupérer sur https://pixabay.com/fr/ ou https://www.pexels.com/fr-fr/
N'hésitez pas à vous inspirer des articles déjà existants.
Et ensuite ?
Une fois l'article crée ou modifié, rendez-vous sur le repository https://github.com/XenoX/Gaucode-blog pour avoir les détails de la procédure. En voici un résumé :
- Créer une branche sous la forme : article/slug-de-larticle (pour une création) ou modification/slug-de-larticle
- Ajouter vos modifications
- Faire un commit
- Pusher votre branche
- Faire une PR (Pull Request) entre votre branche et la branche main en m'ajoutant en reviewer
Tu remarques un bug ou tu as une idée de fonctionnalité ?
Pour cela, je t'invite à faire une issue sur le repository, en expliquant le bug ou à quel point ta fonctionnalité est superbe !