This is the repository of the website expressjs.com. It is hosted directly from the repository as a GitHub Pages website.
Any person who wants to contribute to the Website is welcome! Please read Contributors' Guide for more information on contributing to the Express.js documentation.
If you're interested in contributing to the site's translations, you can find more information here.
Note
If you're only making changes to the content, you most likely won't need to run the site locally.
To preview the website locally, we have two options: using Docker or using Bundler.
Tip
You can run make help to obtain detailed information on how to use our make commands.
- Ensure that you have Docker and Make installed.
- Run
make buildto build the project. - Run
make serveto serve the project, this include live reloading so any change will be reflected (it can take a while, check the logs). - Run
make cleanto remove the docker images and resources generated.
-
Install Ruby and Bundler if you don't have them already.
-
Install the jekyll-redirect-from gem:
$ gem install jekyll-redirect-from
-
Clone this repository by running the following command:
$ git clone https://github.com/expressjs/expressjs.com.git
-
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-pagesgem 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 serveThen, load http://localhost:4000 in your browser.
Content submitted to expressjs.com is Creative Commons Attribution 4.0 International licensed, as found in the LICENSE.md file.