|
1 | 1 | # gaia-mistral.github.io
|
2 | 2 |
|
3 |
| -npm install |
| 3 | +Choisir la langue : [Français](#français) | [English](#english) |
4 | 4 |
|
5 |
| -bundle exec jekyll build |
| 5 | +## Français |
6 | 6 |
|
7 |
| -bundle exec jekyll serve -w |
| 7 | +<a name="français"></a> |
| 8 | + |
| 9 | +Voici les étapes pour configurer et exécuter ce projet. |
| 10 | + |
| 11 | +## Prérequis |
| 12 | + |
| 13 | +Avant de commencer, assurez-vous d'avoir installé les outils suivants : |
| 14 | + |
| 15 | +- [Ruby](https://rubyinstaller.org/) |
| 16 | +- [Node.js](https://nodejs.org/) (qui inclut npm) |
| 17 | + |
| 18 | +## Installation |
| 19 | + |
| 20 | +1. **Installer Ruby** : |
| 21 | + - Téléchargez et installez Ruby depuis [RubyInstaller](https://rubyinstaller.org/). |
| 22 | + - Vérifiez l'installation : |
| 23 | + ```sh |
| 24 | + ruby -v |
| 25 | + ``` |
| 26 | + |
| 27 | +2. **Installer Bundler** : |
| 28 | + - Installez Bundle en exécutant : |
| 29 | + ```sh |
| 30 | + gem install bundler |
| 31 | + ``` |
| 32 | + - Vérifiez l'installation : |
| 33 | + ```sh |
| 34 | + bundle -v |
| 35 | + ``` |
| 36 | + - Utilisation de bundler, éxecuter : |
| 37 | + ```sh |
| 38 | + bundle |
| 39 | + ``` |
| 40 | +
|
| 41 | +3. **Installer les dépendances Node.js** : |
| 42 | + - Assurez-vous que npm est installé : |
| 43 | + ```sh |
| 44 | + npm -v |
| 45 | + ``` |
| 46 | + - Installez les dépendances npm : |
| 47 | + ```sh |
| 48 | + npm install |
| 49 | + ``` |
| 50 | +
|
| 51 | +## Utilisation |
| 52 | +
|
| 53 | +1. **Construire le site** : |
| 54 | + - Pour construire le site Jekyll, exécutez : |
| 55 | + ```sh |
| 56 | + bundle exec jekyll build |
| 57 | + ``` |
| 58 | +
|
| 59 | +2. **Serveur de développement** : |
| 60 | + - Pour lancer un serveur de développement local, exécutez : |
| 61 | + ```sh |
| 62 | + bundle exec jekyll serve -w |
| 63 | + ``` |
| 64 | + - Par défaut, le site sera accessible à l'adresse `http://localhost:4000`. |
| 65 | + |
| 66 | +## Structure des Répertoires |
| 67 | + |
| 68 | +### `_data` |
| 69 | + |
| 70 | +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. |
| 71 | + |
| 72 | +### `_include` |
| 73 | + |
| 74 | +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. |
| 75 | +
|
| 76 | +### `_layouts` |
| 77 | +
|
| 78 | +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). |
| 79 | + |
| 80 | +### `_site` |
| 81 | + |
| 82 | +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é. |
| 83 | + |
| 84 | +### `assets` |
| 85 | + |
| 86 | +Le répertoire `assets` contient les ressources statiques utilisées par le site : |
| 87 | + |
| 88 | +- **`img`** : Ce sous-répertoire contient toutes les images et photos utilisées sur le site. |
| 89 | +- **`css`** : Ce sous-répertoire contient les fichiers CSS, y compris `custom.scss`, qui est utilisé pour personnaliser le style du site. |
| 90 | +- **`js`** : Ce sous-répertoire contient les fichiers JavaScript. |
| 91 | + |
| 92 | +### `_node_modules` |
| 93 | + |
| 94 | +Le répertoire `_node_modules` contient tous les modules installés via npm. Ces modules sont nécessaires pour le fonctionnement du site. |
| 95 | + |
| 96 | +### Vues |
| 97 | + |
| 98 | +Les vues sont situées à la racine du projet et se terminent par `.html` ou `.md`. |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +## English |
| 103 | + |
| 104 | +<a name="english"></a> |
| 105 | + |
| 106 | +Here are the steps to set up and run this project. |
| 107 | + |
| 108 | +## Prerequisites |
| 109 | + |
| 110 | +Before you begin, make sure you have installed the following tools: |
| 111 | + |
| 112 | +- [Ruby](https://rubyinstaller.org/) |
| 113 | +- [Node.js](https://nodejs.org/) (which includes npm) |
| 114 | + |
| 115 | +## Installation |
| 116 | + |
| 117 | +1. **Install Ruby**: |
| 118 | + - Download and install Ruby from [RubyInstaller](https://rubyinstaller.org/). |
| 119 | + - Verify the installation: |
| 120 | + ```sh |
| 121 | + ruby -v |
| 122 | + ``` |
| 123 | + |
| 124 | +2. **Install Bundler**: |
| 125 | + - Install Bundler by running: |
| 126 | + ```sh |
| 127 | + gem install bundler |
| 128 | + ``` |
| 129 | + - Verify the installation: |
| 130 | + ```sh |
| 131 | + bundle -v |
| 132 | + ``` |
| 133 | + - Use Bundler by executing: |
| 134 | + ```sh |
| 135 | + bundle |
| 136 | + ``` |
| 137 | + |
| 138 | +3. **Install Node.js Dependencies**: |
| 139 | + - Ensure npm is installed: |
| 140 | + ```sh |
| 141 | + npm -v |
| 142 | + ``` |
| 143 | + - Install npm dependencies: |
| 144 | + ```sh |
| 145 | + npm install |
| 146 | + ``` |
| 147 | + |
| 148 | +## Usage |
| 149 | + |
| 150 | +1. **Build the Site**: |
| 151 | + - To build the Jekyll site, run: |
| 152 | + ```sh |
| 153 | + bundle exec jekyll build |
| 154 | + ``` |
| 155 | + |
| 156 | +2. **Development Server**: |
| 157 | + - To start a local development server, run: |
| 158 | + ```sh |
| 159 | + bundle exec jekyll serve -w |
| 160 | + ``` |
| 161 | + - By default, the site will be accessible at `http://localhost:4000`. |
| 162 | + |
| 163 | +## Directory Structure |
| 164 | + |
| 165 | +### `_data` |
| 166 | + |
| 167 | +The `_data` directory is used to store data sources in YML format. These YML files can be used to manage configurations, data lists. |
| 168 | + |
| 169 | +### `_include` |
| 170 | + |
| 171 | +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. |
| 172 | + |
| 173 | +### `_layouts` |
| 174 | + |
| 175 | +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.). |
| 176 | + |
| 177 | +### `_site` |
| 178 | + |
| 179 | +The `_site` directory is automatically generated by Jekyll when building the site. It contains the final static site that will be deployed. |
| 180 | + |
| 181 | +### `assets` |
| 182 | + |
| 183 | +The `assets` directory contains the static resources used by the site: |
| 184 | + |
| 185 | +- **`img`**: This subdirectory contains all the images and photos used on the site. |
| 186 | +- **`css`**: This subdirectory contains the CSS files, including `custom.scss`, which is used to customize the site's style. |
| 187 | +- **`js`**: This subdirectory contains the JavaScript files. |
| 188 | +
|
| 189 | +### `_node_modules` |
| 190 | +
|
| 191 | +The `_node_modules` directory contains all the modules installed via npm. These modules are necessary for the site to function. |
| 192 | +
|
| 193 | +### Views |
| 194 | +
|
| 195 | +The views are located at the root of the project and end with `.html` or `.md`. |
0 commit comments