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

GitHub Pages websites being served through Jekyll, you will need to replicate the setup on your local machine to preview the website locally.

Install Ruby and Jekyll on your system, if you don't have them already.

Once installed, cd to the respository directory and run Jekyll using the following command:

$ jekyll s

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

Jekyll uses a variant of Markdown known as Kramdown, read up the docs if you need to go beyond basic Markdown in the doc files.

To understand the template system used by Jekyll, read up the Liquid template engine docs.

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.

Showcasing

If you have an app you'd like to showcase on the site, open a pull request for it.

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 a certain language?

Follow these steps:

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 and footer HTML files for the language in the _includes/ directory, and make necessary edits to the contents.
7. Create a copy of the _includes/api/en and rename it acording to the language code.
8. Make sure to append /\{\{ page.lang }} to all the links within the site.