kicad website
1.0.0
Dies ist die Quelle für die neue Kicad -Website Anno 2015.
Das Kicad-Website-Repository ist zwei lizenziert. Sie können es verteilen und/oder unter den Bestimmungen der GNU General Public Lizenz (http://www.gnu.org/licenses/gpl.html), Version 3 oder höher oder später oder die Creative Commons Attribution Lizenz (http://creativcommons.org/licens/by/by/by/by/.0/), Version 3.0 oder später oder später oder später.
Sie benötigen diese Pakete:
Hugo Version 0.69.0 (Sie müssen diese Version verwenden!)
Ruby (um Asciidoctor zu verwenden)
Asciidoctor Version 2.0.10
Die Verwendung von Asciidoctor ist eine Anforderung, da der ursprüngliche Asciidoc in Schwierigkeiten gerät, die Adoc -Dateien mit TOML -Headern zu analysieren. Asciidoctor verfügt auch über einige zusätzliche Funktionen für Webseiten.
Führen Sie den Befehl hugo im repository root aus, um die Dateien für die Entwicklung zu erstellen und zu bedienen:
Hugo Server -W -v
Beobachten Sie die Konsolenausgabe, da Sie die Adresse mitteilen, in der die Seite in einem Browser zugänglich ist. Das Flag -W -Flag gibt es auf, das Dateisystem für Änderungen zum Wiederaufbau automatisch anzusehen. Außerdem wird die Seite im Browser automatisch automatisch abgeschlossen, sobald der Wiederaufbau erfolgreich abgeschlossen ist.
Bitte lesen Sie die beitragenden Richtlinien
Eine Dockerfile ist enthalten, die die Website mit einer Nginx -Instanz erstellt und verpackt
Damit Symbole in Ermahnungsblöcken erscheinen können, müssen Sie hinzufügen
:icons:
:iconsdir: /img/icons/Oben in der Asciidoc -Datei jedoch unter dem Hugo -Vorlagen -Header.
Bitte benennen Sie alle wiederverwendbaren Asciidoc -Dateien mit einem führenden Unterstrich im Dateinamen und enden in .Adoc. Hugo ist konfiguriert, um solche Dateien absichtlich zu ignorieren.
Um die Sicherheit ein wenig zu verbessern, implementieren wir die von Nginx festgelegten Header für Inhaltssicherheit. Diese diktieren dem Browser, welche Ressourcenpfade für Skripte, Videos, Bilder usw. zulässig sind. Während wir HTTPS verwenden, ist CSP nur ein weiteres Werkzeug, um möglicherweise die Browser -Seite und andere Angriffe zu stoppen.
Dies bedeutet: 1. Bitte fügen Sie alle Bilder, JS und CSS direkt zu diesem Repo hinzu. Es ist weitaus besser für uns, sie widerzuspiegeln, damit sie möglicherweise in Zukunft möglicherweise untergehen. Insbesondere Bilder von Drittanbietern 2. Bitte bemühen Sie sich am besten, vorhandene "genehmigte" Remote -Ressourcen als Visibile in /.docker/default.conf zu verwenden. Wenn Sie feststellen, dass eine Ressource nicht auf das geladen wird, was Sie bearbeiten, überprüfen Sie die Entwickler -Tools -Konsole für Ihren jeweiligen Browser, wenn sie aufgrund von CSP blockiert ist, und es heißt so.
