kicad website

KICAD网站来源

这是新KICAD网站的来源，Anno 2015。

执照

Kicad-Website存储库是双重许可的。您可以根据GNU通用公共许可证（http://www.gnu.org/licenses/gpl.html），版本3或更高版本或以后的版本，或创意共享归属许可（http://creativecommons.org/licenses.org/licensess/licenses/by/by/3.0/3.0或以后）。

先决条件

您将需要以下包裹：

• Hugo版本0.69.0（您必须使用此版本！）

• 红宝石（使用asciidoctor）

• Asciidoctor版本2.0.10

使用Asciidoctor是必需的，因为原始的Asciidoc在用TOML标头的ADOC文件解析时遇到了麻烦。 Asciidoctor还具有一些用于网页的额外功能。

测试

在存储库根中执行Hugo命令以构建和为开发文件提供文件：

雨果服务器-W -V

观察控制台输出，因为它将告诉您在浏览器中可以访问页面的地址。 -w标志告诉它观察文件系统以自动重建更改。此外，一旦重建成功完成，浏览器中的页面将自动化。

贡献

请阅读贡献指南

Docker

包括一个Dockerfile

提示

告诫图标

要使图标出现在告诫块中，您必须添加

 :icons:
:iconsdir: /img/icons/

在Asciidoc文件的顶部，但在Hugo模板标题下方。

ADOC部分

请命名任何可重复使用的ASCIIDOC文件，并在文件名中使用领先的下划线并在.ADOC结束。雨果被配置为故意忽略此类文件。

外部资源

为了稍微提高安全性，我们实现了由NGINX设置的内容 - 安全性 - 政策标头。这些决定了浏览器的脚本，视频，图像等允许的资源路径，而我们确实使用HTTPS，而CSP只是另一种可能阻止浏览器端和其他攻击的工具。

这意味着：1。请直接将任何图像，JS和CSS添加到此存储库中。对于我们来说，反映他们要好得多，以免他们将来有可能下降。尤其是第三方图像2。请尽力将现有的“批准”远程资源用作Visibile在/.docker/default.conf 3中。如果您发现资源不会在编辑内容上加载，请检查各自浏览器的开发人员工具控制台输出，如果CSP由于CSP而被封锁，则会这样说。