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
discourse_theme_cli.md 1.68 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Comment utiliser le Discourse theme CLI ?
    
    ## Utilité
    
    __Discourse theme CLI offre une synchronicité entre son travail en local, et le rendu à distance.__
    
    #### 1 - Installation
    
    Ressources sur [Discourse Theme CLI.](https://meta.discourse.org/t/discourse-theme-cli-console-app-to-help-you-build-themes/82950)
    
    Avant toute chose, il faudra générer une clé API dans Discourse, et on enregistre une clé API par thème.
    
    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
    gem install discourse_theme
    ```
    
    #### 2 - Utilisation
    
    Une fois que le CLI est lancé, Discourse va nous proposer plusieurs options :
    
    - Créer un nouveau thème via le discourse CLI :
    
    ```shell
    discourse_theme new MON_NOUVEAU_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 :
    
    ```shell
    discourse_theme watch component-community-fonts
    ```
    
    - Dernière option : télécharger un thème existant sur le Discourse distant, puis le watch :
    
    ```shell
    discourse_theme download MON_THEME
    ```
    
    #### 3 - Bon à savoir
    
    Ç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é. 
    Exemple :__
    
    ```shell
    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.