Skip to content

Latest commit

 

History

History
105 lines (85 loc) · 6.23 KB

README.md

File metadata and controls

105 lines (85 loc) · 6.23 KB
Raw

nodejs.org

Build Status Dependency Status MIT Licensed

What is this repo?

nodejs.org by the Node.js Foundation builds on the merged community's past website projects to form a self-publishing, community-managed version of the previous site.

On a technical level, inspiration has been taken from the iojs.org repo while design and content has been migrated from the old nodejs.org repo. These technical changes have helped to facilitate community involvement and empower the foundation's internationalization communities to provide alternative website content in other languages.

This repo's issues section has become the primary home for the Website WG's coordination efforts (meeting planning, minute approval, etc.).

Contributing

Please contribute! There are plenty of good first contributions to do.

$ git clone https://github.com/nodejs/nodejs.org.git
$ cd nodejs.org
$ npm install
$ npm start

This will start the development server on http://localhost:8080/en/ and should reload automatically when you make changes but it's all just code and no code is perfect so sometimes you may need to restart it. :)

Note: You'll need Node.js v4 or newer as the build system uses some native ES2015 features.

Layout

  • Page templates are in /layouts
  • Global styles are in /layouts/css
  • Global static files are in /static
  • All content and localization specific styles are in /locale
  • Initial development usually happens in English: /locale/en
  • /locale/{{locale}}/site.json is where global localization information lives.
  • All content is in Markdown and is per locale.
  • The top of each Markdown file is a block of YAML for page specific localization information that is passed to various templates.
  • The bulk of the Markdown content for each page is referenced as {{{content}}} in the corresponding template.

Deployment

Full set up is in https://github.com/nodejs/build/tree/master/setup/www minus secrets and certificates. The webhook is setup on GitHub for this project and talks to a small Node server on the host which does the work. See the github-webhook package for this.

Governance and Current Members

All of the Node.js Foundation websites, including this repo, are jointly governed by the Website Working Group. See GOVERNANCE.md to learn more about the group's structure and CONTRIBUTING.md for guidance about the expectations for all contributors to this project.

Website Working Group Members

Website Working Group Collaborators