The Node.js website.
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
.github GitHub Issue Templates: Fix sort order Jun 9, 2018
external/survey-2018 [Fix] Fix typo error of `Stack Overflow` (#1736) Jul 15, 2018
layouts Fix scroll issue (#1783) Aug 29, 2018
locale Blog: v10.11.0 release post (#1816) Sep 20, 2018
scripts Add filters for Nodejs 10 (#1772) Aug 19, 2018
source source: update versions Mar 9, 2016
static Update Node+JS Interactive banner (#1781) Aug 27, 2018
tests Update dependencies (#1206) Apr 22, 2017
.editorconfig Remove double properties in `.editorconfig` (#905) Sep 21, 2016
.eslintrc Add .eslintrc to ensure that editor plugins will use the correct conf… Sep 29, 2016
.gitignore comment gitignore and add commonly ignored stuff Feb 25, 2016
.htmllintrc Update dependencies (#1206) Apr 22, 2017
.stylintrc build: add stylint to check stylus files Apr 27, 2016
.travis.yml build: switch travis to node 8 (#1459) Nov 8, 2017
COLLABORATOR_GUIDE.md docs: update landing policy for press releases (#1183) Mar 28, 2017
CONTRIBUTING.md Update link to CoC Nov 24, 2017
GOVERNANCE.md remove member list clearly (#1797) Sep 6, 2018
LICENSE Uppercase Node.js in LICENSE (#855) Aug 10, 2016
README.md remove member list clearly (#1797) Sep 6, 2018
TRANSLATION.md Fix typos (#1130) Feb 7, 2017
build.js banner: update banner post august 2018 security release availability (#… Aug 16, 2018
package-lock.json update metalsmith-markdown Sep 16, 2018
package.json update metalsmith-markdown Sep 16, 2018
server.js server: highlight server url Sep 3, 2018

README.md

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 issues to work on. To get started, you have to fork this repo to your own GitHub account first. Then open up a terminal on your machine and enter the following commands:

$ git clone https://github.com/<your user name>/nodejs.org.git
$ cd nodejs.org
$ npm install
$ npm start

This will start the development server on http://localhost:8080/en/. This should reload automatically when you make changes to the code, but 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.

If you want to submit a new feature or a bugfix, the best way is to create the changes in a separate branch, e.g.: git checkout -b feature/mycoolfeature. This will make it easier for you to submit a pull request and get your feature merged.

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

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.

Content vs. Code

The Website Working Group is primarily concerned with the code and overall structure of the website.

The content of the website comes from a variety of working groups (Evangelism, Core, i18n, etc). The Website WG defers to these WGs on matters of content and routinely adds collaborators from these working groups as they add and improve content on the website. In other words, the Website WG is not an editorial Working Group except when no other Working Group has taken responsibility for a content area.