Skip to content

Latest commit

 

History

History
195 lines (135 loc) · 5.33 KB

README.md

File metadata and controls

195 lines (135 loc) · 5.33 KB

gaia-mistral.github.io

Choisir la langue : Français | English

Français

Voici les étapes pour configurer et exécuter ce projet.

Prérequis

Avant de commencer, assurez-vous d'avoir installé les outils suivants :

Installation

  1. Installer Ruby :

    • Téléchargez et installez Ruby version 2.6.6 depuis RubyInstaller.
    • Vérifiez l'installation : 
      ruby -v

  2. Installer Bundler :

    • Installez Bundle version 2.3.26 en exécutant : 
      gem install bundler -v 2.3.26
    • Vérifiez l'installation : 
      bundle -v
    • Utilisation de bundler, éxecuter : 
      bundle

  3. Installer les dépendances Node.js :

    • Assurez-vous que npm est installé : 
      npm -v
    • Installez les dépendances npm : 
      npm install

Utilisation

  1. Construire le site :

    • Pour construire le site Jekyll, exécutez : 
      bundle exec jekyll build

  2. Serveur de développement :

    • Pour lancer un serveur de développement local, exécutez : 
      bundle exec jekyll serve -w
    • Par défaut, le site sera accessible à l'adresse http://localhost:4000.

Structure des Répertoires

_data

Le répertoire _data est utilisé pour stocker les sources de données au format YML. Ces fichiers YML peuvent être utilisés pour gérer des configurations, des listes de données.

_include

Le répertoire _include contient toutes les vues qui seront réutilisées sur d'autres vues (header, footer, etc.). Ces fichiers sont inclus dans les layouts et les pages pour éviter la duplication de code.

_layouts

Le répertoire _layouts correspond à la structure de la page. Les fichiers dans ce répertoire définissent la mise en page du site et font appel aux fichiers d'inclusion (header, footer, etc).

_site

Le répertoire _site est généré automatiquement par Jekyll lors de la construction du site. Il contient le site statique final qui sera déployé.

assets

Le répertoire assets contient les ressources statiques utilisées par le site :

  • img : Ce sous-répertoire contient toutes les images et photos utilisées sur le site.
  • css : Ce sous-répertoire contient les fichiers CSS, y compris custom.scss, qui est utilisé pour personnaliser le style du site.
  • js : Ce sous-répertoire contient les fichiers JavaScript.

_node_modules

Le répertoire _node_modules contient tous les modules installés via npm. Ces modules sont nécessaires pour le fonctionnement du site.

Vues

Les vues sont situées à la racine du projet et se terminent par .html ou .md.

English

Here are the steps to set up and run this project.

Prerequisites

Before you begin, make sure you have installed the following tools:

Installation

  1. Install Ruby:

    • Download and install Ruby version 2.6.6 from RubyInstaller.
    • Verify the installation: 
      ruby -v

  2. Install Bundler:

    • Install Bundler version 2.3.26 by running: 
      gem install bundler -v 2.3.26
    • Verify the installation: 
      bundle -v
    • Use Bundler by executing: 
      bundle

  3. Install Node.js Dependencies:

    • Ensure npm is installed: 
      npm -v
    • Install npm dependencies: 
      npm install

Usage

  1. Build the Site:

    • To build the Jekyll site, run: 
      bundle exec jekyll build

  2. Development Server:

    • To start a local development server, run: 
      bundle exec jekyll serve -w
    • By default, the site will be accessible at http://localhost:4000.

Directory Structure

_data

The _data directory is used to store data sources in YML format. These YML files can be used to manage configurations, data lists.

_include

The _include directory contains all the views that will be reused on other views (header, footer, etc.). These files are included in the layouts and pages to avoid code duplication.

_layouts

The _layouts directory corresponds to the page structure. The files in this directory define the layout of the site and call the inclusion files (header, footer, etc.).

_site

The _site directory is automatically generated by Jekyll when building the site. It contains the final static site that will be deployed.

assets

The assets directory contains the static resources used by the site:

  • img: This subdirectory contains all the images and photos used on the site.
  • css: This subdirectory contains the CSS files, including custom.scss, which is used to customize the site's style.
  • js: This subdirectory contains the JavaScript files.

_node_modules

The _node_modules directory contains all the modules installed via npm. These modules are necessary for the site to function.

Views

The views are located at the root of the project and end with .html or .md.