Switch branches/tags
Nothing to show
Clone or download
crandmck Merge pull request #1001 from bvaisakh/patch-1
State functionality of 'next(err)' upfront.
Latest commit fd9ec82 Nov 10, 2018
Permalink
Failed to load latest commit information.
2x Remove all Express 2.x code and leave only HTML docs Jul 29, 2018
_data Add Express 4.16.4 changelog Oct 11, 2018
_includes typo Nov 3, 2018
_layouts facebook share image Oct 12, 2018
css CSS tweaked to move fixed menu from the right to left of page. Aug 15, 2018
de adjust german translation of 'disable' Nov 7, 2018
en Merge pull request #1001 from bvaisakh/patch-1 Nov 10, 2018
es Add --no-view attribute on express-generator guide Aug 10, 2018
fonts Update Thai translated for Getting started May 27, 2018
fr Add --no-view attribute on express-generator guide Aug 10, 2018
images facebook share image Oct 12, 2018
it Add --no-view attribute on express-generator guide Aug 10, 2018
ja Fix layout issues Oct 17, 2018
js Fix "Edit this page" link Jun 19, 2017
ko #400 add bracket in example Nov 1, 2018
pt-br Add --no-view attribute on express-generator guide Aug 10, 2018
ru Merge pull request #965 from hw0k/develop Aug 14, 2018
sk Add --no-view attribute on express-generator guide Aug 10, 2018
th Add --no-view attribute on express-generator guide Aug 10, 2018
tr Add note about dynamic routes after 404 handler Sep 17, 2018
uk Add --no-view attribute on express-generator guide Aug 10, 2018
uz Add --no-view attribute on express-generator guide Aug 10, 2018
zh-cn Add --no-view attribute on express-generator guide Aug 10, 2018
zh-tw Add --no-view attribute on express-generator guide Aug 10, 2018
.gitignore Update .gitignore Aug 11, 2016
CNAME init jekyll Feb 8, 2015
CONTRIBUTING.md Update CONTRIBUTING.md Aug 22, 2017
Gemfile Change page layout to fix build Dec 15, 2016
LICENSE.md Update LICENSE.md Jul 5, 2016
README.md Improve local setup steps formatting & readme URLs Oct 4, 2018
_config.yml Fixes 'No GitHub API authentication' error per github/pages-gem#399 Aug 17, 2017
get-readmes.sh Move files around and redo readme script Oct 2, 2017
index.md Add security update to English banner and move up Sep 26, 2017
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
    
  3. 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.

  4. Run Jekyll using the following command:

    $ bundle exec jekyll serve
    

    Then, 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:

```js
var express = require('express')
var app = express()
app.listen(3000)
```

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.