Jekyll le plus simple
Un site minimal basé sur Jekyll sur les pages GH, réduit à une page de contenu avec un thème
Prévisualisation
À propos
Ceci est un modèle et un projet de démonstration en direct. Il montre à quel point vous avez besoin de configurer pour obtenir un site Jekyll sur les pages GH.
- index.md
- Pour la page d'accueil - la seule page dans ce cas.
- Si vous omettez cette page,
README.md sera utilisé comme page d'accueil.
- _config.yml
- Définissez le thème - qui gère la mise en page et le style.
- Activer le plugin de sitemap Jekyll - L'activer dans Gemfile ne suffit pas. Notez que les autres plugins seront activés pour vous comme la frontal en option.
- D'autres valeurs standard comme
baseurl , title et description ont été exclues de la configuration. Lors de la construction sur les pages GH, celles-ci seront déduites pour vous par le GEM des pages GH.
- Gemfile
- Ce n'est pas réellement utilisé par les pages GH, mais il vous permet d'installer le thème Jekyll localement à l'aide de Bundler.
- Utilisez un seul GEM
github-pages si vous souhaitez correspondre à toutes les gemmes sur les pages GH (qui peuvent être lourdes à installer). - Supprimez ce fichier si vous n'avez pas besoin d'exécuter votre site localement.
Si vous voulez un exemple plus à part entière d'un site de plusieurs pages avec des messages, des gemmes, des dispositions, etc., vérifiez mon référentiel Jekyll-Blog-Demo. Qui peut également être utilisé comme modèle et site de démonstration.
Comment utiliser ce projet
Installation
- Cliquez sur Utiliser ce modèle pour créer un nouveau dépôt dans votre propre compte. Vous pouvez laisser le nom comme
simplest-jekyll . - Activez les pages GitHub dans les paramètres de votre repo. Choisissez de servir à partir de
master Branch et de l'option / Path. - Vérifiez l'onglet Environnement de votre repo pour voir quand le déploiement est terminé.
- Cliquez sur Afficher le déploiement pour voir le site en direct. par exemple https://michaelcurrin.github.io/simplest-jekyll/
Notez que /simplest-jekyll/index.html est disponible immédiatement, mais il faut quelques minutes jusqu'à ce que les pages GitHub fabriquent /simplest-jekyll/ disponible.
Personnaliser
- Mettez à jour le
README.md avec vos propres détails. Ceci n'est pas réellement utilisé dans le site déployé mais est visible localement et sur github. - Thèmes
- Modifiez le thème dans _config.yml si vous voulez un autre thème.
- Vous pouvez également utiliser la section GitHub Pages des paramètres de réapprovisionnement pour prévisualiser visuellement.
- Remarque Seuls les thèmes pris en charge par les pages GitHub sont couverts (environ 10), mais si vous utilisez le champ Remote_Theme dans votre configuration, vous pouvez référencer plus de thèmes.
- Pour l'installation et l'exécution localement, vous devrez vous assurer que votre gemfile couvre le thème utilisé dans la configuration.
- Comme pour la plupart des sites Jekyll, l'index.md est utilisé comme page d'accueil.
- Il a une matière avant en haut afin que tout liquide soit appliqué.
- Modifiez votre fichier
index.md avec votre propre contenu en tant que HTML ou Markdown. - Vous pouvez le renommer sur
index.html si vous ne voulez que html simple. - Vous pouvez retirer la matière frontale en haut pour éliminer le formatage liquide et tout thème.
- Si vous le souhaitez, ajoutez plus de pages à la racine et éclatez tout HTML commun tel que l'en-tête ou la tête ou la barre de navigation dans le dossier
_includes ou le dossier _layouts (aucun n'est couvert dans la portée de ce projet mais sont courants pour les projets Jekyll). - Voir les documents et tutoriels sur le site Jekyll pour plus d'informations.
- Exécutez éventuellement Jekyll localement:
- Installez Ruby et Bundler.
- Installer Project Gems - Jekyll et le thème Gem.
- Exécutez Jekyll Dev Server.
- Pour des instructions plus complètes, voir Docs of Jekyll Blog Demo. Vous devrez également ajouter un
Makefile pour correspondre à ces commandes.
Projets connexes
- - Blog par défaut généré avec Jekyll CLI. Utilisation d'un thème, d'un contenu, d'une configuration de style, de gemmes et d'un makefile.
- - Utilisation de Jekyll 4, un thème, des actions GitHub et des pages GitHub.
- - Site de Jekyll minimal avec un thème mais pas de gemfile.
Licence
Sorti sous MIT par @michaelcurrin.
