Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit b673dd27 authored by Christophe Chaudier's avatar Christophe Chaudier :rocket:
Browse files

refactor: clarification of the use of the cli

parent 29a73588
No related branches found
No related tags found
No related merge requests found
# Comment utiliser le Discourse theme CLI ? # Comment utiliser le Discourse Theme CLI ?
## Utilité ## Utilité
__Discourse theme CLI offre une synchronicité entre son travail en local, et le rendu à distance.__ > Discourse Theme CLI permet de syncroniser son code local avec une instance discourse en ligne.
#### 1 - Installation #### Installation
Ressources sur [Discourse Theme CLI.](https://meta.discourse.org/t/discourse-theme-cli-console-app-to-help-you-build-themes/82950) Il faut commencer par générer une clé API dans Discourse, et on enregistre une clé API par thème.
Avant toute chose, il faudra générer une clé API dans Discourse, et on enregistre une clé API par thème. 1. Installer `Ruby 2.2` minimum.
2. Installer la gem `discourse_theme`.
Le Theme CLI est utilisé via __Ruby 2.2__ au minimum. Il faut donc l'installer et mettre à jour sa version de Ruby. ```bash
Une fois cette étape réalisée, on installe le Discourse dans son local.
```shell
gem install discourse_theme gem install discourse_theme
``` ```
#### 2 - Utilisation - [Ressources sur Discourse Theme CLI.](https://meta.discourse.org/t/discourse-theme-cli-console-app-to-help-you-build-themes/82950)
#### Utilisation
Une fois que le CLI est lancé, Discourse va nous proposer plusieurs options : Au lancement la CLI va nous proposer plusieurs options :
- Créer un nouveau thème via le discourse CLI : 1. Créer un nouveau thème via le discourse CLI :
```shell ```bash
discourse_theme new MON_NOUVEAU_THEME discourse_theme new <my_new_theme>
``` ```
- Modifier un thème ou un composant existant sur notre Discourse en local, et user de la synchronicité. Pour se faire, on doit se retrouver à la racine du dossier dans notre répertoire, et lancer le watch. 2. Syncroniser un thème ou un composant local avec le Discours distant. Pour ça on doit lancer le `watch` sur le répartoire de notre projet.
Exemple :
```shell ```bash
discourse_theme watch component-community-fonts discourse_theme watch <my_theme>
``` ```
- Dernière option : télécharger un thème existant sur le Discourse distant, puis le watch : 3. Télécharger un thème existant sur le Discourse distant, et le syncronisé grace au `watch`.
```shell ```bash
discourse_theme download MON_THEME discourse_theme download <my_remote_theme>
``` ```
#### Bon à savoir
#### 3 - Bon à savoir Ça y est ! Vous utilisez Discourse Theme CLI et vous avez la possibilité de créer ou de `watch` des thèmes et des composants.
Ça y est ! Vous utilisez Discourse CLI et vous avez la possibilité de créer ou de watch des thèmes et des composants. **⛔ Note : il n'est pas possible de regarder plusieurs thèmes/composants en simultané.**
__Note : il n'est pas possible de regarder plusieurs thèmes/composants en simultané. Exemple :
Exemple :__
```shell ```bash
discourse_theme watch component-community-fonts community-theme component-colors discourse_theme watch component-community-fonts community-theme component-colors
``` ```
Ceci génèrera une erreur, alors nous procédons élément par élément.
Ceci génèrera une erreur. Il faut dans ce cas lancer un cli par répertoire.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment