expressjs.com

Expressjs.com

这是网站expressjs.com的存储库。它直接从存储库作为GitHub页面网站托管。

本地设置

在本地预览该网站：

1. 如果还没有它们，请安装Ruby和Bundler。

2. 安装jekyll-redirect-from gem：

   $ gem install jekyll-redirect-from

3. 通过运行以下命令来克隆此存储库：

   $ git clone https://github.com/expressjs/expressjs.com.git

4. 导航到克隆的存储库目录并运行以下命令：

   $ bundle install

   Bundler将介绍要安装的宝石的Gemfile。 github-pages GEM包含与GitHub页面使用的其他版本的Jekyll和其他依赖关系，因此您的本地设置将尽可能接近GitHub页面。

5. 使用以下命令运行jekyll：

   $ bundle exec jekyll serve

   然后，在浏览器中加载http：// localhost：4000。

使用Docker的本地设置

提示

您可以运行make help ，以获取有关如何使用我们的命令的详细信息。

0. 确保您有Docker并安装。
1. 运行make build以构建项目。
2. 运行式make serve以服务于项目，这包括实时重新加载，因此任何更改都将被反映（可能需要一段时间，检查日志）。
3. 运行make clean以删除生成的Docker图像和资源。

格式化

Jekyll使用了称为Kramdown的Markdown的变体。

Jekyll使用液体模板引擎进行模板。

您可以将GFM围栏代码块用于JavaScript；例如：

 ``JS
var express = require（'express'）
var app = express（）
app.listen（3000）
````````

结果看起来像这样：

 const express = require ( 'express' )
const app = express ( )
app . listen ( 3000 )

默认的github页面语法突出显示已在_config.yml中被禁用，以允许使用prism.js突出显示。

贡献

可以随意更改模板文件或文档文件。支持文档位于其各自目录中，API文档位于_includes目录下。

请参阅《贡献者指南》以获取有关文档贡献的更多信息，包括有关贡献翻译的信息。

为什么要使用jekyll而不是基于明确的解决方案？

Jekyll带有GitHub页面内置。由于我们已经在使用GitHub页面来托管该网站，因此利用其提供的功能是有意义的。在正确的情况下，这一切都是关于使用正确的工具作为正确的工作。