Blog HoppR - Documentation

Bienvenue dans la documentation du Blog HoppR. Ce projet est une plateforme de blog moderne utilisant Nuxt.js, intégrant Notion pour la gestion de contenu et GitHub pour le contrôle de version.

Table des matières

1. Blog HoppR - Documentation
   1. Table des matières
   2. Pour commencer
   3. Guide utilisateur
   4. Documentation technique
   5. API

Pour commencer

• Installation
• Configuration
• Démarrage rapide

Guide utilisateur

• Rédiger un article de blog
• Publier un article
• Gérer les auteurs

Documentation technique

• Architecture globale
• Intégration Notion
• Intégration GitHub
• Génération de Markdown
• Configuration Nuxt
• Déploiement

API

• API Notion
• API GitHub
• API Slack

Pour plus d'informations sur l'utilisation du blog, veuillez consulter notre documentation utilisateur sur Notion.

Scripts de formatage pour le blog

Ce dépôt contient des scripts utilitaires pour formater le contenu du blog.

Scripts disponibles

Formatage des guillemets dans le frontmatter (addFrontmatterQuotes.ts)

Ce script ajoute des guillemets doubles autour des valeurs des champs spécifiques dans le frontmatter des fichiers Markdown.

Champs concernés :

• title
• description
• alt

Les guillemets doubles existantes dans ces champs sont automatiquement échappées avec un backslash.

Utilisation :

npx tsx scripts/addFrontmatterQuotes.ts

Exemple de transformation :

# Avant
title: Mon titre avec "guillemets"

# Après
title: "Mon titre avec \"guillemets\""

Contribution

Pour contribuer, assurez-vous de :

1. Tester vos modifications sur des fichiers de test avant de les appliquer sur le contenu réel
2. Maintenir la compatibilité avec le format YAML existant
3. Documenter tout nouveau script ou modification majeure