minimal

Le thème Minimal

Minimal est un thème Jekyll pour les pages GitHub. Vous pouvez prévisualiser le thème pour voir à quoi il ressemble, ou même l'utiliser aujourd'hui.

Usage

Pour utiliser le thème Minimal :

1. Ajoutez ce qui suit au _config.yml de votre site :

    remote_theme : pages-themes/[email protected]
   plugins :
   - jekyll-remote-theme # add this line to the plugins list if you already have one

2. Facultativement, si vous souhaitez prévisualiser votre site sur votre ordinateur, ajoutez ce qui suit au Gemfile de votre site :

    gem "github-pages" , group : :jekyll_plugins 

Personnalisation

Variables de configuration

Minimal respectera les variables suivantes, si elles sont définies dans _config.yml de votre site :

 title : [The title of your site]
description : [A short description of your site's purpose]

De plus, vous pouvez choisir de définir les variables facultatives suivantes :

 show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]

Feuille de style

Si vous souhaitez ajouter vos propres styles personnalisés :

1. Créez un fichier appelé /assets/css/style.scss sur votre site
2. Ajoutez le contenu suivant en haut du fichier, exactement comme indiqué :

   ---
   ---
   
   @import " {{ site.theme }} " ;

3. Ajoutez tout CSS personnalisé (ou Sass, y compris les importations) que vous souhaitez immédiatement après la ligne @import

Remarque : Si vous souhaitez modifier les variables Sass du thème, vous devez définir de nouvelles valeurs avant la ligne @import dans votre feuille de style.

Mises en page

Si vous souhaitez modifier la mise en page HTML du thème :

1. Pour certaines modifications telles qu'une favicon personnalisée, vous pouvez ajouter des fichiers personnalisés dans votre dossier _includes local. Les fichiers fournis avec le thème constituent un point de départ et sont inclus dans le modèle de mise en page d'origine.
2. Pour des modifications plus importantes, copiez le modèle original depuis le référentiel du thème
   ( Conseil de pro : cliquez sur "brut" pour faciliter la copie )
3. Créez un fichier appelé /_layouts/default.html sur votre site
4. Collez le contenu de la mise en page par défaut copié lors de la première étape
5. Personnalisez la mise en page comme vous le souhaitez

Personnalisation du code Google Analytics

Google a publié plusieurs itérations de son code Google Analytics au fil des années depuis la création de ce thème. Si vous souhaitez profiter du dernier code, collez-le dans _includes/head-custom-google-analytics.html sur votre site Jekyll.

Remplacement des URL générées par GitHub

Les modèles s'appuient souvent sur des URL fournies par GitHub, telles que des liens vers votre référentiel ou des liens pour télécharger votre projet. Si vous souhaitez remplacer une ou plusieurs URL par défaut :

1. Examinez la source du modèle pour déterminer le nom de la variable. Ce sera sous la forme de {{ site.github.zip_url }} .
2. Spécifiez l'URL que vous souhaitez que le modèle utilise dans _config.yml de votre site. Par exemple, si la variable était site.github.url , vous ajouteriez ce qui suit :

    github :
     zip_url : http://example.com/download.zip
     another_url : another value

3. Lorsque votre site sera créé, Jekyll utilisera l'URL que vous avez spécifiée, plutôt que celle par défaut fournie par GitHub.

Remarque : Vous devez supprimer le site. préfixe, et chaque nom de variable (après le github. ) doit être mis en retrait de deux espaces en dessous de github: .

Pour plus d'informations, consultez la documentation des variables Jekyll.

Feuille de route

Consultez les problèmes ouverts pour une liste des fonctionnalités proposées (et des problèmes connus).

Philosophie du projet

Le thème Minimal est destiné à permettre aux utilisateurs de GitHub Pages de créer rapidement et facilement leur premier (ou 100e) site Web. Le thème doit répondre dès le départ à la grande majorité des besoins des utilisateurs, en péchant par excès de simplicité plutôt que de flexibilité, et offrir aux utilisateurs la possibilité d'opter pour une complexité supplémentaire s'ils ont des besoins spécifiques ou souhaitent personnaliser davantage leur expérience. (comme l'ajout de CSS personnalisé ou la modification de la mise en page par défaut). Cela devrait aussi être superbe, mais cela va sans dire.

Contribuer

Vous souhaitez contribuer à Minimal ? Nous serions ravis de votre aide. Minimal est un projet open source, construit une contribution à la fois par des utilisateurs comme vous. Consultez le fichier CONTRIBUTION pour savoir comment contribuer.

Prévisualiser le thème localement

Si vous souhaitez prévisualiser le thème localement (par exemple, en train de proposer un changement) :

1. Clonez le référentiel du thème ( git clone https://github.com/pages-themes/minimal )
2. cd dans le répertoire du thème
3. Exécutez script/bootstrap pour installer les dépendances nécessaires
4. Exécutez bundle exec jekyll serve pour démarrer le serveur de prévisualisation
5. Visitez localhost:4000 dans votre navigateur pour prévisualiser le thème

Exécution de tests

Le thème contient une suite de tests minimale, pour garantir qu'un site avec le thème sera construit avec succès. Pour exécuter les tests, exécutez simplement script/cibuild . Vous devrez exécuter script/bootstrap une fois avant que le script de test fonctionne.