expressjs.com

Expressjs.com

Это хранилище веб -сайта Expressjs.com. Он размещается непосредственно из хранилища в качестве веб -сайта GitHub Pages.

Локальная установка

Для предварительного просмотра веб -сайта на локальном уровне:

1. Установите Ruby и Bundler, если у вас их еще нет.

2. Установите драгоценный камень Jekyll-redirect-from:

   $ gem install jekyll-redirect-from

3. Клонировать этот репозиторий, выполнив следующую команду:

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

4. Перейдите к клонированному каталогу репозитория и запустите следующую команду:

   $ bundle install

   Бундлер будет смотреть в Gemfile, для которого жемчужины для установки. GEM github-pages включает в себя ту же версию Jekyll и других зависимостей, что и Github Pages, так что ваша локальная настройка отражает страницы GitHub как можно ближе.

5. Запустите Jekyll, используя следующую команду:

   $ bundle exec jekyll serve

   Затем загрузите http: // localhost: 4000 в вашем браузере.

Локальная установка с использованием Docker

Кончик

Вы можете запустить make help , чтобы получить подробную информацию о том, как использовать наши команды Make.

0. Убедитесь, что у вас есть Docker и сделайте установленные.
1. Запустить make build , чтобы построить проект.
2. Запустить make serve для обслуживания проекта, это включает в себя перезагрузку в прямом эфире, чтобы быть отражено любое изменение (это может занять некоторое время, проверить журналы).
3. Запустите, make clean , чтобы удалить сгенерированные изображения и ресурсы Docker.

Форматирование

Jekyll использует вариант отметки, известный как Kramdown.

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 для размещения веб -сайта, имеет смысл использовать возможности, которые он предоставляет. Все дело в использовании правильного инструмента для правильной работы при правильных обстоятельствах.