Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
HTML JavaScript Groff CSS Other
branch: gh-pages

Merge pull request #358 from Rudimental/patch-2

(cleanup) Update error-handling.md
latest commit ac3f44a99d
@crandmck crandmck authored
Failed to load latest commit information.
2x init jekyll
3x i18n init
4x fix #348
_includes relative link to static files doc
_layouts i18n file org
advanced Clarifying template documentation
css padding with scrollbars in place
es Initial Spanish language
fonts init jekyll
guide Update error-handling.md
images Add Glip to applicatins page
ja i18n file org
js adjust menu height on load/resize Fixes #351
resources i18n init
ru i18n file org
starter Update faq.md
zh Translate generator.md to Chinese
.gitignore init jekyll
CNAME init jekyll
CONTRIBUTING.md docs
README.md docs
_config.yml code hilight
api.md broken links fixed
index.md Initial Spanish language

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

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. Clone the Express repository
  2. Create a directory for the language of your choice using its ISO 639-1 code as its name.
  3. Copy index.md, api.md, starter/, guide/, advanced/, resources/, 4x/, and 3x/, to the language directory.
  4. Remove the link to 2.x docs from the "API Reference" menu.
  5. Update the lang variable in the copied markdown files.
  6. Update the title variable in the copied markdown files.
  7. 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.
  8. Create the announcement file for the language in the _includes/ directory.
  9. Create a copy of the _includes/api/en and rename it acording to the language code.
  10. Make sure to append /{{ page.lang }} to all the links within the site.
Something went wrong with that request. Please try again.