Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superorbital/golangcookbook.github.io
Golang Cookbook
https://github.com/superorbital/golangcookbook.github.io
Last synced: 18 days ago
JSON representation
Golang Cookbook
- Host: GitHub
- URL: https://github.com/superorbital/golangcookbook.github.io
- Owner: superorbital
- License: other
- Created: 2015-02-28T09:52:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T23:57:03.000Z (3 months ago)
- Last Synced: 2024-08-07T02:51:49.366Z (3 months ago)
- Language: CSS
- Homepage: http://golangcookbook.com
- Size: 18.6 MB
- Stars: 409
- Watchers: 34
- Forks: 59
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Go Cookbook
Source for [the Go Cookbook](http://golangcookbook.com), a
community build and contributed collection of practical
recipes for real world Golang development, supported by
[SuperOrbital](https://superorbit.al).
### Contributing
The Go Cookbook is supported by
[SuperOrbital](https://superorbit.al), but built by the
community, so your contributions are very welcome. Just send
a pull request for any changes or additions.
#### Adding a New Recipe
Recipes are generated from the [_data/chapters.yml
file](https://github.com/golangcookbook/golangcookbook.github.io/blob/master/_data/chapters.yml),
which is used to build [the index
page](https://github.com/golangcookbook/golangcookbook.github.io/blob/master/index.md).
The `chapters.yml` file format is:
```
- title: Strings
recipes:
- title: Concatenating Strings
path: /chapters/strings/concatenation
wip: true
- title: Detecting a Substring
path: /chapters/strings/detecting
- title: Detecting All Substrings
path: false
```
Specifying `wip: true` puts "[Work in progress]" in front of
the recipe in the index. Setting `path: false` causes the
recipe to be listed without a link.
#### Recipe Format
Recipe files have a couple of required properties, specified
in the preamble like such:
``` yaml
---
title: Processing a String One Word or Character at a Time
question: Given a string, how do I break it into words or characters and process each one in turn?
---
```
Also, to show example code, recipes can make use of the `{%
include example.html example="filename" %}` helper. This will
include both `filename.go` as example source code, and
`filename.expected.escaped` as the output of that code. If
you're curious, [here's the definition for that
helper](https://github.com/golangcookbook/golangcookbook.github.io/blob/master/_includes/example.html).
The `filename.expected.escaped` files are automatically
generated by the `./run_tests` script, described below.
### Run locally
This project uses Docker for local development. Once you
have Docker installed:
``` console
$ ./run server
$ open http://localhost:4000
```
### Run the tests
``` console
$ ./run tests
```
The `run_tests` script not only runs the tests, but also
ensures that the `.expected`, `.go.escaped`, and
`.expected.escaped` files are in place. These files are then
used in the recipe templates to ensure all examples are up to
date and correct.
### License
[](http://creativecommons.org/licenses/by-nc-sa/4.0/)
The Go Cookbook copyright
[SuperOrbital](https://superorbit.al), and is licensed under
a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0
International
License](http://creativecommons.org/licenses/by-nc-sa/4.0/).