4f399ec422
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> |
||
---|---|---|
cmd | ||
content | ||
internal | ||
.prettierrc | ||
AUTHORS | ||
CONTRIBUTING.md | ||
CONTRIBUTORS | ||
LICENSE | ||
PATENTS | ||
README.md | ||
codereview.cfg | ||
favicon.ico | ||
go.mod | ||
go.sum | ||
robots.txt |
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.