[mirror] Home of the go.dev and golang.org websites
Перейти к файлу
Russ Cox 4f399ec422 website: update README.md
Update README.md to explain how to make basic content changes,
with a link to the content/README.md for advanced things.

Fixes golang/go#39687.

Change-Id: Ie2a603422f4c7057ffdab71f434b60f53e99a828
Reviewed-on: https://go-review.googlesource.com/c/website/+/251121
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2020-08-28 16:03:04 +00:00
cmd cmd/golangorg: print service address when serving 2020-08-27 20:30:05 +00:00
content content/static/doc: set proper header ids in module documentation 2020-08-03 21:34:06 +00:00
internal internal/history: document upcoming Go 1.15.1 and Go 1.14.8 security releases 2020-08-27 18:39:52 +00:00
.prettierrc all: add a section on JS/CSS formatting to README 2020-05-28 18:41:37 +00:00
AUTHORS initial commit 2019-01-04 09:34:42 -05:00
CONTRIBUTING.md initial commit 2019-01-04 09:34:42 -05:00
CONTRIBUTORS initial commit 2019-01-04 09:34:42 -05:00
LICENSE initial commit 2019-01-04 09:34:42 -05:00
PATENTS initial commit 2019-01-04 09:34:42 -05:00
README.md website: update README.md 2020-08-28 16:03:04 +00:00
codereview.cfg x/website: add code and static files for website 2019-01-08 18:22:29 +00:00
favicon.ico x/website: add code and static files for website 2019-01-08 18:22:29 +00:00
go.mod website: update to tools@97606e32 2020-08-27 20:30:11 +00:00
go.sum website: update to tools@97606e32 2020-08-27 20:30:11 +00:00
robots.txt x/website: add code and static files for website 2019-01-08 18:22:29 +00:00

README.md

Go website

This repository holds the Go website server code and content.

Checkout and Run

To download and run the golang.org web server locally:

  • git clone https://go.googlesource.com/website
  • cd website
  • go run ./cmd/golangorg
  • Open http://localhost:6060/ in your browser.

See cmd/golangorg/README.md for more details.

Changing Content

To make basic changes to the golang.org website content:

  • Make the changes you want in the content/static directory.
  • Stop any running go run ./cmd/golangorg.
  • go generate ./content/static
  • go run ./cmd/golangorg
  • Open http://localhost:6060/ in your browser.

See content/README.md for more sophisticated instructions.

JS/CSS Formatting

This repository uses prettier to format JS and CSS files.

The version of prettier used is 1.18.2.

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

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The main issue tracker for the website repository is located at https://github.com/golang/go/issues. Prefix your issue with "x/website:" in the subject line, so it is easy to find.