Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.9 KB

README.md

File metadata and controls

82 lines (53 loc) · 2.9 KB
Raw

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. Clone this repository by running the following command:

    $ git clone https://github.com/expressjs/expressjs.com.git

  4. Navigate to the cloned repository directory and run the following command:

    $ 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.

  5. Run Jekyll using the following command:

    $ bundle exec jekyll serve

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

Local Setup using Docker

Tip

You can run make help to obtain detailed information on how to use our make commands.

  1. Ensure that you have Docker and Make installed.
  2. Run make build to build the project.
  3. Run make serve to serve the project, this include live reloading so any change will be reflected (it can take a while, check the logs).
  4. Run make clean to remove the docker images and resources generated.

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:

const express = require('express')
const 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.