kicad website
1.0.0
Cette source pour le nouveau site Web de Kicad, Anno 2015.
Le référentiel Kicad-WebSite est en double licence. Vous pouvez le distribuer et / ou le modifier en vertu des termes de la licence publique générale GNU (http://www.gnu.org/licenses/gpl.html), version 3 ou ultérieure, ou la licence d'attribution des communes créatives (http://creativecommons.org/licensens/by/3.0/), version 3.0 ou plus tard.
Vous aurez besoin de ces forfaits:
Hugo Version 0.69.0 (vous devez utiliser cette version!)
Ruby (pour utiliser asciidoctor)
asciidoctor version 2.0.10
L'utilisation d'Asciidoctor est une exigence, car l'Asciidoc d'origine se heurte à des problèmes d'analyse des fichiers ADOC avec des en-têtes Toml. Asciidoctor a également quelques fonctionnalités supplémentaires pour les pages Web.
Exécutez la commande Hugo dans la racine du référentiel pour créer et servir les fichiers pour le développement:
Hugo Server -W -V
Observez la sortie de la console car elle vous indiquera l'adresse où la page est accessible dans un navigateur. L'indicateur -W lui dit de regarder le système de fichiers pour les modifications de reconstruction automatiquement. De plus, la page du navigateur sera auto-orefresh une fois la reconstruction terminée avec succès.
Veuillez lire les directives contributives
Un dockerfile est inclus qui construit et emballe le site Web avec une instance Nginx
Pour que les icônes apparaissent dans des blocs d'accomplissement, vous devez ajouter
:icons:
:iconsdir: /img/icons/En haut du fichier Asciidoc mais en dessous de l'en-tête du modèle Hugo.
Veuillez nommer tous les fichiers ASCIIDOC réutilisables avec un soulignement leader dans le nom de fichier et se terminant par .adoc. Hugo est configuré pour ignorer ces fichiers exprès.
Pour améliorer un peu la sécurité, nous mettons en œuvre des en-têtes de politique de sécurité contenu qui sont définis par Nginx. Ceux-ci dictent au navigateur quels chemins de ressources sont admissibles pour les scripts, les vidéos, les images, etc. et bien que nous utilisons HTTPS, CSP est juste un autre outil pour potentiellement arrêter le côté du navigateur et d'autres attaques.
Cela signifie: 1. Veuillez ajouter toutes les images, JS et CSS directement à ce dépôt. C'est bien mieux pour nous de les refléter de peur qu'ils ne disent potentiellement à l'avenir. En particulier les images tierces 2. Veuillez faire le meilleur effort pour utiliser les ressources distantes "approuvées" existantes comme visibile dans /.docker/default.conf 3. Si vous remarquez qu'une ressource ne se charge pas sur ce que vous modifiez, vérifiez la sortie de la console des outils du développeur pour votre navigateur respectif, s'il est bloqué en raison du CSP, il le dira.
