website
packagemoduleThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
README¶
Go website
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.
JS/TS/CSS Formatting
This repository useseslint to format JS and TS files,andstylelint to format CSS files.
See also:
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.
Installing npm Dependencies:
- Installdocker
- Create a .gitignore file at repo root
- Add .gitignore and node_modules to .gitignore
- Run
./npm install
Run ESlint
./npx eslint [options] [file] [dir]
Run Stylelint
./npx stylelint [input] [options]
TypeScript Support
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.
Run Jest
./npx jest [TestPathPattern]
Deploying
Each time a CL is reviewed and submitted, the code is deployed to App Engine.Seecmd/golangorg/README.md for details.
Report Issues / Send Patches
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.
Documentation¶
Directories¶
Path | Synopsis |
---|---|
_content | |
blog/appenginecommand This server can run on App Engine. | This server can run on App Engine. |
blog/chacha8randcommand | |
blog/h2push/servercommand The server command demonstrates a server with HTTP/2 Server Push support. | The server command demonstrates a server with HTTP/2 Server Push support. |
blog/survey2016command | |
blog/survey2017command | |
doc/codewalkcommand Generating random text: a Markov chain algorithm | Generating random text: a Markov chain algorithm |
doc/playcommand You can edit this code! Click here and start typing. | You can edit this code! Click here and start typing. |
talks/2014/go4java/runner Package runner provides a Runner type that is used to define both RunCounter and EmbeddedRunCounter to show examples of how to use composition in Go. | Package runner provides a Runner type that is used to define both RunCounter and EmbeddedRunCounter to show examples of how to use composition in Go. |
talks/2014/organizeiocommand | |
talks/2014/research2command | |
talks/2014/tastecommand | |
talks/2015/keeping-upcommand | |
blogmodule | |
cmd | |
adminappcommand The admingolangorg command serves an administrative interface for owners of the golang-org Google Cloud project. | The admingolangorg command serves an administrative interface for owners of the golang-org Google Cloud project. |
adminredirectcommand The adminredirect app redirects traffic to the new admin host. | The adminredirect app redirects traffic to the new admin host. |
checklinkscommand The checklinks command checks for broken links in the gopls documentation, recursively traversing from the main page. | The checklinks command checks for broken links in the gopls documentation, recursively traversing from the main page. |
golangorgcommand Golangorg serves the golang.org web sites. | Golangorg serves the golang.org web sites. |
googlegolangorgcommand A trivial redirector for google.golang.org. | A trivial redirector for google.golang.org. |
locktriggercommand Locktrigger “locks” a given build trigger, making sure that the currently running build is the only trigger running. | Locktrigger “locks” a given build trigger, making sure that the currently running build is the only trigger running. |
screentestcommand Screentest compares images of rendered web pages. | Screentest compares images of rendered web pages. |
versionprunecommand Versionprune prunes stale AppEngine versions for a specified service. | Versionprune prunes stale AppEngine versions for a specified service. |
go.devmodule | |
internal | |
blog/atom Package atom defines XML data structures for an Atom feed. | Package atom defines XML data structures for an Atom feed. |
codewalk Package codewalk implements support for codewalk documents. | Package codewalk implements support for codewalk documents. |
dl Package dl implements a simple Go downloads frontend server. | Package dl implements a simple Go downloads frontend server. |
env Package env provides environment information for the golangorg server running on golang.org. | Package env provides environment information for the golangorg server running on golang.org. |
gitfs Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS. | Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS. |
history Package history holds the Go project release history. | Package history holds the Go project release history. |
memcache Package memcache provides a minimally compatible interface for google.golang.org/appengine/memcache and stores the data in Redis (e.g., via Cloud Memorystore). | Package memcache provides a minimally compatible interface for google.golang.org/appengine/memcache and stores the data in Redis (e.g., via Cloud Memorystore). |
pkgdoc Package pkgdoc serves package documentation. | Package pkgdoc serves package documentation. |
redirect Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc. | Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc. |
short Package short implements a simple URL shortener, serving shortened urls from /s/key. | Package short implements a simple URL shortener, serving shortened urls from /s/key. |
spec Package spec implements hyperlinking of the Go language specification. | Package spec implements hyperlinking of the Go language specification. |
texthtml Package texthtml formats text files to HTML. | Package texthtml formats text files to HTML. |
tmplfunc Package tmplfunc provides an extension of Go templates in which templates can be invoked as if they were functions. | Package tmplfunc provides an extension of Go templates in which templates can be invoked as if they were functions. |
web Package web implements a basic web site serving framework. | Package web implements a basic web site serving framework. |
webtest Package webtest implements script-based testing for web servers. | Package webtest implements script-based testing for web servers. |