HTML JavaScript Groff CSS Shell Makefile
Latest commit 7b679fe Dec 1, 2016 @Tobsta Tobsta committed with hacksparrow Fix grammar in res.sendFile documentation (#744)
Fix grammar in res.sendFile documentation
Permalink
Failed to load latest commit information.
2x 3.x warning Sep 7, 2015
_includes Fix grammar in res.sendFile documentation (#744) Dec 1, 2016
_layouts Rework layouts and scripts for middleware module docs Aug 10, 2016
css Merge pull request #740 from expressjs/node-interactive Nov 23, 2016
de Update generator documentation to 4.14.0 Oct 31, 2016
en Fix broken link, closes #743 Nov 28, 2016
es Update generator documentation to 4.14.0 Oct 31, 2016
fonts init jekyll Feb 8, 2015
fr Update generator documentation to 4.14.0 Oct 31, 2016
images add node interactive section Nov 23, 2016
it Update generator documentation to 4.14.0 Oct 31, 2016
ja Update generator documentation to 4.14.0 Oct 31, 2016
js mobile menu in small browser window Sep 19, 2016
ko Update generator documentation to 4.14.0 Oct 31, 2016
pt-br Update generator documentation to 4.14.0 Oct 31, 2016
ru Update generator documentation to 4.14.0 Oct 31, 2016
sk Update generator documentation to 4.14.0 Oct 31, 2016
uk Update generator documentation to 4.14.0 Oct 31, 2016
uz Update generator documentation to 4.14.0 Oct 31, 2016
zh-cn Update generator documentation to 4.14.0 Oct 31, 2016
zh-tw Update generator documentation to 4.14.0 Oct 31, 2016
.gitignore Update .gitignore Aug 11, 2016
CNAME init jekyll Feb 8, 2015
CONTRIBUTING.md Add license file and update footers Jun 30, 2016
Gemfile Replace tags with backticks, and other changes Apr 25, 2016
LICENSE.md Update LICENSE.md Jul 5, 2016
README.md Follow standard style Oct 6, 2016
_config.yml Replace tags with backticks, and other changes Apr 25, 2016
get-readmes.sh Final cleanup of docs for middleware and util modules Aug 17, 2016
index.md add node interactive section Nov 23, 2016
package.json Add eslint Oct 6, 2016

README.md

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:

  1. Install Ruby and Bundler if you don't have them already.

  2. Install the jekyll-redirect-from gem:

$ gem install jekyll-redirect-from
  1. cd to the repository directory and run the following command:
$ cd expressjs.com
$ bundle install

Bundler will look in the Gemfile for which gems to install. The github-pages gem 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 serve

Then, load http://localhost:4000/ on your browser.

Formatting

Jekyll uses a variant of Markdown known as Kramdown.

Jekyll uses the Liquid template engine for templating.

You can use http://kramdown.gettalong.org/parser/gfm.html fenced code blocks for JavaScript; for example:

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.