9e216da9ef
After go1.16, go will use module mode by default, even when the repository is checked out under GOPATH or in a one-off directory. Add go.mod, go.sum to keep this repo buildable without opting out of the module mode. > go mod init github.com/mmcgrana/gobyexample > go mod tidy > go mod vendor In module mode, the 'vendor' directory is special and its contents will be actively maintained by the go command. pygments aren't the dependency the go will know about, so it will delete the contents from vendor directory. Move it to `third_party` directory now. And, vendor the blackfriday package. Note: the tutorial contents are not affected by the change in go1.16 because all the examples in this tutorial ask users to run the go command with the explicit list of files to be compiled (e.g. `go run hello-world.go` or `go build command-line-arguments.go`). When the source list is provided, the go command does not have to compute the build list and whether it's running in GOPATH mode or module mode becomes irrelevant.
83 lines
2.6 KiB
Markdown
83 lines
2.6 KiB
Markdown
# Go by Example
|
|
|
|
Content and build toolchain for [Go by Example](https://gobyexample.com),
|
|
a site that teaches Go via annotated example programs.
|
|
|
|
### Overview
|
|
|
|
The Go by Example site is built by extracting code and
|
|
comments from source files in `examples` and rendering
|
|
them via the `templates` into a static `public`
|
|
directory. The programs implementing this build process
|
|
are in `tools`, along with some vendor'd dependencies
|
|
in `vendor` and `third_party`.
|
|
|
|
The built `public` directory can be served by any
|
|
static content system. The production site uses S3 and
|
|
CloudFront, for example.
|
|
|
|
### Building
|
|
|
|
[](https://travis-ci.com/mmcgrana/gobyexample)
|
|
|
|
To build the site you'll need Go and Python installed. Run:
|
|
|
|
```console
|
|
$ go get github.com/russross/blackfriday
|
|
$ tools/build
|
|
```
|
|
|
|
To build continuously in a loop:
|
|
|
|
```console
|
|
$ tools/build-loop
|
|
```
|
|
|
|
To see the site locally:
|
|
|
|
```
|
|
$ tools/serve
|
|
```
|
|
|
|
and open `http://127.0.0.1:8000/` in your browser.
|
|
|
|
### Publishing
|
|
|
|
To upload the site:
|
|
|
|
```console
|
|
$ gem install aws-sdk
|
|
$ export AWS_ACCESS_KEY_ID=...
|
|
$ export AWS_SECRET_ACCESS_KEY=...
|
|
$ tools/upload
|
|
```
|
|
|
|
### License
|
|
|
|
This work is copyright Mark McGranaghan and licensed under a
|
|
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
|
|
|
|
The Go Gopher is copyright [Renée French](http://reneefrench.blogspot.com/) and licensed under a
|
|
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
|
|
|
|
|
|
### Translations
|
|
|
|
Contributor translations of the Go by Example site are available in:
|
|
|
|
* [Chinese](https://gobyexample-cn.github.io/) by [gobyexample-cn](https://github.com/gobyexample-cn)
|
|
* [Czech](http://gobyexamples.sweb.cz/) by [martinkunc](https://github.com/martinkunc/gobyexample-cz)
|
|
* [French](http://le-go-par-l-exemple.keiruaprod.fr) by [keirua](https://github.com/keirua/gobyexample)
|
|
* [Italian](http://gobyexample.it) by the [Go Italian community](https://github.com/golangit/gobyexample-it)
|
|
* [Japanese](http://spinute.org/go-by-example) by [spinute](https://github.com/spinute)
|
|
* [Korean](https://mingrammer.com/gobyexample/) by [mingrammer](https://github.com/mingrammer)
|
|
* [Russian](https://gobyexample.com.ru/) by [badkaktus](https://github.com/badkaktus)
|
|
* [Spanish](http://goconejemplos.com) by the [Go Mexico community](https://github.com/dabit/gobyexample)
|
|
* [Ukrainian](http://butuzov.github.io/gobyexample/) by [butuzov](https://github.com/butuzov/gobyexample)
|
|
|
|
### Thanks
|
|
|
|
Thanks to [Jeremy Ashkenas](https://github.com/jashkenas)
|
|
for [Docco](http://jashkenas.github.com/docco/), which
|
|
inspired this project.
|