riteshbabu / expressjs.com

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.

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.

How do I help translate the docs to another language?

IMPORTANT: We have professional translations of the Express documentation into:

• German
• French
• Italian
• Spanish
• Brazilian Portuguese
• Japanese
• Simplified Chinese
• Traditional Chinese
• Russian
• Korean

Therefore we can no longer accept community translations for these languages, except for corrections to the existing translations.

We welcome contributions of translations into other languages, following the procedure below.

Follow these steps:

0. Clone the Express repository
1. Create a directory for the language of your choice using its ISO 639-1 code as its name.
2. Copy index.md, api.md, starter/, guide/, advanced/, resources/, 4x/, and 3x/, to the language directory.
3. Remove the link to 2.x docs from the "API Reference" menu.
4. Update the lang variable in the copied markdown files.
5. Update the title variable in the copied markdown files.
6. Create the header, footer, notice, and announcement file for the language in the _includes/ directory, in the respective directories, and make necessary edits to the contents.
7. Create the announcement file for the language in the _includes/ directory.
8. Create a copy of the _includes/api/en and rename it according to the language code.
9. Make sure to append /{{ page.lang }} to all the links within the site.