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頁面來託管該網站，因此利用其提供的功能是有意義的。這全都是在正確的情況下使用合適的工具，用於正確的工作。