Skip to content

jcbhmr/gobyexample.jcbhmr.com

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

You're probably looking for gobyexample.jcbhmr.com

Go by Example

๐Ÿ”ฐ gobyexample.jcbhmr.com website
๐Ÿ”€ Forked from mmcgrana/gobyexample

๐ŸŒŽ Translations all in one place
๐Ÿ“˜ Uses mdBook
๐Ÿ” Searchable
๐Ÿ“ฑ Mobile-friendly
๐Ÿ”— Side panel for quick navigation
๐Ÿ’ป Code examples run in the browser!

Development

Go mdBook

You'll need:

Each language is its own mdBook project. You can start the development server with mdbook serve <dir> where <dir> is the language directory.

mdbook serve # English
mdbook serve ./fr/ # French

Every so often remember to run mdbook test but for go code blocks:

./scripts/mdbook-test-go.go # English
./scripts/mdbook-test-go.go ./fr/ # French

You can preview the full multilingual site by first building each language (mdbook build <dir>) and then serving the book/ directory with your favorite static file server.

mdbook build # English
mdbook build ./fr/ # French
# ...
python -m http.server -d ./book/

Why fork?

  • The original is not mobile-friendly. This is my #1 gripe. This website is mobile friendly. Thanks mdBook!
  • The original doesn't let you run code examples like Rust by Example. That's a feature that I want. This website has it.
  • The original doesn't have a side panel to quickly jump between pages; you have to go back to the index page. This website has that. There's also < and > buttons.
  • The original doesn't have centralized community translations. This website houses all translations in one place.
  • The original's build setup is custom & complicated. This website uses mdBook, mdbook-i18n-helpers, and GitHub Pages.

License

Copyright (c) 2012 Mark McGranaghan
Copyright (c) 2025 Jacob Hummer
Creative Commons Attribution 3.0 Unported License

About

๐Ÿ”ฐ gobyexample.jcbhmr.com website

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 53.1%
  • SCSS 35.9%
  • JavaScript 11.0%