Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.4 KB
Raw

Contributing to expressjs.com

This respository is only for issues related to the website http://expressjs.com. For issues related to Express, the framework, go to https://github.com/strongloop/express.

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.

Help translate the docs to other languages

We are looking for volunteers to help translate the Express docs to other languages.

Interested? Please 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.

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.