HTML JavaScript Groff GCC Machine Description CSS Shell Other
Latest commit 8ced17e Sep 24, 2016 @crandmck crandmck committed on GitHub Merge pull request #715 from JonathanPrince/jade-to-pug-de
Change Jade to Pug in german docs
Permalink
Failed to load latest commit information.
2x 3.x warning Sep 7, 2015
_includes Merge pull request #706 from expressjs/fix-menu Sep 6, 2016
_layouts Rework layouts and scripts for middleware module docs Aug 10, 2016
css Link/target refactor Sep 2, 2016
de Change Jade to Pug in german guide Sep 24, 2016
en Remove unsafe space character from example path Sep 21, 2016
es Minor fixes in samples. Mar 20, 2016
fonts init jekyll Feb 8, 2015
fr Minor fixes in samples. Mar 20, 2016
images Update Companies Using Express Aug 10, 2016
it Italian translation tweaked in index.html Aug 2, 2016
ja Merge pull request #620 from abouthiroppy/feature/modify-Japanese-ref… Apr 22, 2016
js mobile menu in small browser window Sep 19, 2016
ko Found an awkward Korean word Jul 14, 2016
pt-br Minor fixes in samples. Mar 20, 2016
ru Minor fixes in samples. Mar 20, 2016
sk Update Companies Using Express Aug 10, 2016
uk add uk translate May 14, 2016
uz added announcement and changelog Jul 28, 2016
zh-cn fixed some typos Apr 21, 2016
zh-tw Move copyright notice from .md to template files Mar 7, 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 Add new page for governance info May 11, 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 Link/target refactor Sep 2, 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.