Node.js Website built using Next.js with TypeScript, SCSS and MDXv2
Nodejs.org by the OpenJS Foundation is the official website for the Node.js® JavaScript runtime. This repo is the source code for the website. It is built using Next.js, a React Framework.
npm ci
npx turbo serve
# listening at localhost:3000- Page templates are in
/layouts - Global styles are in
/styles - Public files are in
/public - i18n configuration is on
i18n/config.json - Global static files are in
/public/static- Legacy static files are in
/public/static/legacy
- Legacy static files are in
- All content is in
/pages- Initial development usually happens in English:
/pages/en /i18n/locales/{{locale}}.jsonis 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 (Frontmatter) for page-specific localization information passed to various templates.
- The bulk of the Markdown content for each page is referenced as
{children}on their respective JSX Layout (layouts/)
- Initial development usually happens in English:
This project adopts the Node.js Code of Conduct.
Any person who wants to contribute to the Website is welcome! Please read Contribution Guidelines and see the Figma Design to understand better the structure of this repository.
If you want to help translate to other languages or improve existing translations, it is optional to work from GitHub. You can and should do it through Crowdin; this is the correct workflow.
Crowdin is an online tool that facilitates the user experience for the translator; here is more information:
Website translations are handled via Crowdin.
To help with localization, please read the Translation guide.
The Website is automatically deployed to Vercel through its GitHub App integration when new pushes happen on the main branch.
Details regarding the deployment are only accessible to the maintainers of the Website Team due to certain limitations.
The current integration is owned by the OpenJS Foundation and managed by the Website Team.
Legacy Deployment
Full setup is in https://github.com/nodejs/build/tree/master/ansible/www-standalone minus secrets and certificates.
The webhook is set up 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.
- Thanks to all contributors and collaborators that make this project possible.
- Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.
- Thanks to Vercel for providing the infrastructure that serves and powers the Node.js Website
- Thanks to Cloudflare for providing the infrastructure that serves Node.js's Website, Node.js's CDN and more.