Skip to content

tfredrich/RestApiTutorial.com

Repository files navigation

RestApiTutorial.com

Hugo source for www.RestApiTutorial.com. This repo also contains the downloadable formats (PDF/ePub/Mobi/ODT) for the RESTful Best Practices document.

Project layout highlights:

  • content/ holds Hugo pages and section indexes.
  • layouts/ contains site-specific theme overrides.
  • static/ includes assets copied verbatim.
  • media/ stores the downloadable book formats.
  • public/ is generated output and should not be edited by hand.

Contributor notes:

  • Read AGENTS.md before making changes.
  • This site uses the project-local ./bin/hugo wrapper (vendored Hugo v0.126.1 in tools/hugo) and the Hugo-Relearn theme v7.0.1; later versions will break the build (needs upgrading).
  • Contributors MUST download Hugo into tools/ before development.

Run the site locally:

./bin/hugo server -D

Download Hugo 0.126.1 into tools/hugo (macOS):

mkdir -p tools/hugo
curl -L -o /tmp/hugo_0.126.1.tar.gz https://github.com/gohugoio/hugo/releases/download/v0.126.1/hugo_extended_0.126.1_darwin-universal.tar.gz
tar -xzf /tmp/hugo_0.126.1.tar.gz -C tools/hugo
rm /tmp/hugo_0.126.1.tar.gz

Download Hugo 0.126.1 into tools/hugo (Linux x86_64):

mkdir -p tools/hugo
curl -L -o /tmp/hugo_0.126.1.tar.gz https://github.com/gohugoio/hugo/releases/download/v0.126.1/hugo_extended_0.126.1_linux-amd64.tar.gz
tar -xzf /tmp/hugo_0.126.1.tar.gz -C tools/hugo
rm /tmp/hugo_0.126.1.tar.gz

Download Hugo 0.126.1 into tools/hugo (Linux arm64):

mkdir -p tools/hugo
curl -L -o /tmp/hugo_0.126.1.tar.gz https://github.com/gohugoio/hugo/releases/download/v0.126.1/hugo_extended_0.126.1_linux-arm64.tar.gz
tar -xzf /tmp/hugo_0.126.1.tar.gz -C tools/hugo
rm /tmp/hugo_0.126.1.tar.gz

alt Creative Commons License

This work by RestApiTutorial.com is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.