expressjs.com
This is the repository of the website expressjs.com. It is hosted directly from the repository as a GitHub Pages website.
Local Setup
To preview the website locally:
-
Install Ruby and Bundler if you don't have them already.
-
Install the jekyll-redirect-from gem:
$ gem install jekyll-redirect-from -
cdto the repository directory and run the following command:$ cd expressjs.com $ bundle installBundler will look in the Gemfile for which gems to install. The
github-pagesgem includes the same version of Jekyll and other dependencies as used by GitHub Pages, so that your local setup mirrors GitHub Pages as closely as possible. -
Run Jekyll using the following command:
$ bundle exec jekyll serveThen, load http://localhost:4000 in your browser.
Formatting
Jekyll uses a variant of Markdown known as Kramdown.
Jekyll uses the Liquid template engine for templating.
You can use GFM fenced code blocks for JavaScript; for example:
The result looks like this:
var express = require('express')
var app = express()
app.listen(3000)
The default GitHub Pages syntax highlighting has been disabled in _config.yml to allow highlighting with prism.js.
Contributing
Feel free to make changes to the template files or the document files. The supporting docs are located in their respective directories, and the API docs are located under the _includes directory.
Please see the Contributors' Guide for more information on contributing to the documentation, including information on contributing translations.
Why use Jekyll instead of an Express-based solution?
Jekyll comes built-in with GitHub Pages. Since we are already using GitHub Pages to host the website, it makes sense to leverage the capabilities it provides. It's all about using the right tool, for the right job, under the right circumstances.