diff --git a/doc/discourse_theme_cli.md b/doc/discourse_theme_cli.md index 6d71449b078aa964d65e9a7f5399b476b38afa43..294f14c81bf039aa9e737bb6b388f7f14288c71c 100644 --- a/doc/discourse_theme_cli.md +++ b/doc/discourse_theme_cli.md @@ -1,54 +1,53 @@ -# Comment utiliser le Discourse theme CLI ? +# Comment utiliser le Discourse Theme CLI ? ## 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. - -Une fois cette étape réalisée, on installe le Discourse dans son local. - -```shell +```bash 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 -discourse_theme new MON_NOUVEAU_THEME +```bash +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. -Exemple : +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. -```shell -discourse_theme watch component-community-fonts +```bash +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 -discourse_theme download MON_THEME +```bash +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 ``` -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.