alexwlchan.net

Alexwlchan.net

Dieses Repo hat den Code für meine persönliche Website Alexwlchan.net, eine statische Website, die mit Jekyll erstellt wurde. Es enthält eine Reihe von Plugins, die ich geschrieben habe, um die Website anzupassen.

Schlüsselwerkzeuge

Die Website verwendet:

• Jekyll, das die HTML -Seiten erzeugt
• Sass, zum Aufbau der CSS und Stylesheets
• GitHub -Aktionen, die die Website erstellt und bereitstellt
• Caddy, der Webserver ist

Wenn ich eine Änderung vornehmen möchte, öffne ich eine Pull -Anfrage. Dies löst einen Build mit Github -Aktionen aus und überprüft im Rahmen des Builds das HTML mit HTML -Profis. Dies prüft, ob fehlende ALT -Text, defekte Links, ungültige HTML usw. usw.

Wenn die Website Schecks überschreitet, wird sie automatisch verschmolzen und der Aufbau in der main die Änderung an meinem Webserver veröffentlicht.

Aufbau des Standorts

Sie brauchen Git, Ruby und Python installiert.

Um eine lokale Kopie der Website auszuführen:

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

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

$ bundle install

$ bundle exec jekyll serve

Die Website sollte auf http: // localhost: 5757 ausgeführt werden. Wenn Sie Änderungen an den Quelldateien vornehmen, wird automatisch aktualisiert.

So erstellen Sie einen einmaligen Satz statischer HTML-Dateien:

$ bundle exec jekyll build

Dadurch wird eine Reihe von HTML -Dateien in _site erstellt.

Wie die Website funktioniert

Ich veröffentliche den Quellcode, damit andere Personen sehen können, wie die Website funktioniert, und vielleicht einige der Ideen für ihre eigenen Websites verwenden. Dies ist eine Liste von Dingen, die ich für interessant oder ungewöhnlich halte:

• Atom -Feed -Generierung
• No-Javascript Twitter Einbettungen
• Verknüpfung mit meiner Arbeit an anderen Websites
• Validierung der Frontmunde in Markdown -Dateien

Beitragen

Korrekturen für Tippfehler sind willkommen, aber ansonsten werden Beiträge ignoriert.

Wenn Sie eine der Komponenten in Ihren eigenen Projekten verwenden möchten - Plugins, Layouts, Stylesheets - können Sie dies gerne tun.

Lizenz

• Sofern nicht auf andere Weise notiert, werden die Site und der zugehörige Code zwei lizenziert wie:

  • Creative Commons Attribution 4.0 International (auch bekannt als CC von 4.0)
  • Die MIT -Lizenz

  Wenn Sie meinen Inhalt wiederverwenden, können Sie die am besten geeignete Lizenz verwenden.

  Meistens ist der CC BY in Ordnung, aber Creative Commons -Lizenzen sind nicht für Code geeignet, daher habe ich ein MIT als Alternative.

• Einige Bilder, die unter Creative Commons -Lizenzen von anderen Personen verwendet werden; Siehe den Beitrag, in dem ein Bild zur Zuordnung verwendet wird.

• Alle Symbole auf der Website werden unter einer Lizenzfreiheit des NOUN-Projekts verwendet. In den SVG -Dateien sollten Kommentare angegeben werden, die ihre Quelle angeben. Die ursprünglichen Symbolautoren behalten das Urheberrecht.