Repository files navigation

This repo holds content and serving programs for the go.dev and golang.org web sites.

Content is in _content/ (go.dev) and tour/ (go.dev/tour).Server code is in cmd/ and internal/.

To run the combined go.dev+golang.org server to preview local content changes, use:

go run ./cmd/golangorg

The supporting programs cmd/admingolangorg and cmd/googlegolangorgare the servers for admin.golang.org and google.golang.org.(They do not use the _content/ directories.)

Each command directory has its own README.md explaining deployment.

This repository useseslint to format JS and TS files,andstylelint to format CSS files.

See also:

• CSS
• JavaScript
• TypeScript

It is encouraged that all JS, TS, and CSS code be run through formatters beforesubmitting a change. However, it is not a strict requirement enforced by CI.

1. Installdocker
2. Create a .gitignore file at repo root
3. Add .gitignore and node_modules to .gitignore
4. Run./npm install

./npx eslint [options] [file] [dir]

./npx stylelint [input] [options]

TypeScript files served from _content are transformed into JavaScript.Reference .ts files in html templates as module code.

<script type="module" src="/ts/filename.ts">

Write unit tests for TypeScript code using thejesttesting framework.

./npx jest [TestPathPattern]

Each time a CL is reviewed and submitted, the code is deployed to App Engine.Seecmd/golangorg/README.md for details.

This repository uses Gerrit for code changes. To learn how to submit changes tothis repository, seehttps://go.dev/doc/contribute.

The git repository ishttps://go.googlesource.com/website.

The main issue tracker for the website repository is located athttps://go.dev/issues. Prefix your issue with "x/website:" in thesubject line, so it is easy to find.