website metalsmith

快速燃料

警告：
该存储库是Fastify网站的前任，直到2023年6月。
新家现在是fastify/website-next

该项目用于构建用于快速网络框架的网站并在线发布。

要求

• 节点12+
• 使用npm install安装依赖项

建造

为了触发网站的构建，您只需要运行：

npm run build

这将执行创建构建所需的所有步骤（静态网站）。

如果您正在开发，则可以运行：

npm start

这将触发构建，并启动一台Live服务器，使您可以可视化网站上执行的更改。

（请注意，每当您更改构成网站内容的资产时，您将需要启动npm run build:website以触发重建）

建立步骤

如果您有兴趣了解构建过程的工作原理，这是执行过程中执行的主要步骤：

1. 清理：删除可能从以前的构建中创建的临时资源
2. 临时文件夹创建：为构建过程创建所需的文件夹
3. 获取版本：使用GitHub API下载Fastify的最新版本，以便可以动态地重新生成文档页面。
4. 流程发布：处理释放的过程创建从原始快速版本派生的所有必要的动态文件（主要用于生成和处理文档页面）
5. 网站生成：使用金属史密斯来编译网站的静态版本。

查看包脚本以了解哪些文件触发这些操作，以防您要查看上述任何步骤的代码。

出版作为github页面

该网站是使用github页面（分支gh-pages ）自动发行的CI。

每当Master上发生更改时，如果成功创建了构建，则将自动发布在GitHub页面上。

为了使此功能正常，需要正确配置Circle CI，以提供所有必要的环境变量：

• DOMAIN ：在GitHub页面（ www.fastify.io ）中使用的自定义域
• GH_EMAIL ：在CircleCi授权的GITHUB用户的电子邮件推入gh-pages分支机构
• GH_NAME ：GITHUB用户在CircleCi授权推向gh-pages分支的用户名
• GH_TOKEN ：（可选）github个人访问令牌对于GH_NAME指定的用户。如果存在，则将对GitHub的API调用进行身份验证。
• CLOUDFLARE_EMAIL ：CloudFlare帐户的电子邮件
• CLOUDFLARE_AUTH_KEY ：在CloudFlare API上执行API调用的授权键
• CLOUDFLARE_ZONE ：与当前域关联的Cloudflare区域的ID

贡献

非常欢迎每个人为这个项目做出贡献。您可以仅通过提交错误或通过打开问题或发送拉动请求来提出改进来做出贡献。

执照

根据MIT许可获得许可。 ©OpenJS基金会和Fastify团队。