Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 2.04 KB

Contributing to expressjs.com

This repository is only for issues related to the website http://expressjs.com. For issues related to Express, the framework, go to https://github.com/expressjs/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.

Content on this site is licensed under a Creative Commons Attribution-ShareAlike 3.0 United States License. See https://creativecommons.org/licenses/by-sa/3.0/us/ for a layman's summary; See LICENSE.md for the full license.

Contributing translations

IMPORTANT: We have professional translations of the Express documentation into:

  • German
  • French
  • Italian
  • Spanish
  • Brazilian Portuguese
  • Japanese
  • Simplified Chinese
  • Traditional Chinese
  • Russian
  • Korean

Therefore we can no longer accept community translations for these languages, except for corrections to the existing translations.

We welcome contributions of translations into other languages, following the procedure below.

Follow these steps:

  1. Clone the expressjs.com 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. Make sure to append /{{ page.lang }} to all the links within the site.