alexwlchan.net

alexwlchan.net

Ce dépôt a le code pour mon site personnel, Alexwlchan.net, qui est un site statique construit avec Jekyll. Il comprend un certain nombre de plugins que j'ai écrits pour personnaliser le site.

Outils clés

Le site utilise:

• Jekyll, qui génère les pages HTML
• Sass, pour construire le CSS et les feuilles de style
• GitHub Actions, qui construit et déploie le site
• Caddy, qui est le serveur Web

Quand je veux faire un changement, j'ouvre une demande de traction. Cela déclenche une version avec des actions GitHub, et dans le cadre de la construction, il vérifie le HTML avec HTMLProoder. Cela vérifie le texte ALT manquant, les liens cassés, le HTML non valide, etc.

Si le site passe des vérifications, il est automatiquement fusionné et la construction de la branche main publie la modification de mon serveur Web.

Construire le site

Vous avez besoin de Git, Ruby et Python installés.

Pour exécuter une copie locale du site:

$ git clone [email protected]:alexwlchan/alexwlchan.net.git

$ python3 -m venv .venv
$ pip install -r requirements.txt

$ bundle install

$ bundle exec jekyll serve

Le site doit être exécuté sur http: // localhost: 5757. Si vous apportez des modifications aux fichiers source, il mettra automatiquement à jour.

Pour construire un ensemble unique de fichiers HTML statiques:

$ bundle exec jekyll build

Cela crée un ensemble de fichiers HTML dans _site .

Comment fonctionne le site

Je publie le code source afin que d'autres personnes puissent voir comment fonctionne le site et peut-être utiliser certaines des idées pour leurs propres sites. Ceci est une liste de choses que je pense être intéressantes ou inhabituelles:

• Génération d'aliments pour atomes
• Les intégres Twitter sans javascript
• Liant à mon travail sur d'autres sites
• Valider la front

Contributif

Les correctifs pour les fautes de frappe sont les bienvenus, mais sinon les contributions seront ignorées.

Si vous souhaitez utiliser l'un des composants de vos propres projets - plugins, dispositions, feuilles de style - n'hésitez pas à le faire.

Licence

• Sauf si autrement noté, le site et le code associé sont à double licence comme:

  • Creative Commons Attribution 4.0 International (AKA CC by 4.0)
  • La licence MIT

  Si vous réutilisez mon contenu, vous pouvez utiliser la licence la plus appropriée.

  La plupart du temps, le CC By est bien, mais les licences Creative Commons ne conviennent pas au code, j'ai donc le MIT comme alternative.

• Certaines images qui sont utilisées sous licence Creative Commons d'autres personnes; Voir l'article où une image est utilisée pour l'attribution.

• Toutes les icônes du site sont utilisées sous une licence libre de droits du projet Noun; Il devrait y avoir des commentaires dans les fichiers SVG indiquant leur source. Les auteurs d'icônes d'origine conservent le droit d'auteur.