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.

Key pages:

• REST API Tutorial
• HTTP Status Codes

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.
• tools/ contains internal (and local) tools for the project.

Contributor notes:

• Read AGENTS.md before making changes.
• This site uses the project-local ./bin/hugo wrapper (vendored Hugo v0.147.7 in tools/hugo) and the Hugo-Relearn theme v8.3.0; later versions MAY break the build.
• Contributors MUST download Hugo into tools/ before development.

Run the site locally:

./bin/hugo server -D

Ad placement notes:

• Top ads render in layouts/partials/heading-pre.html, which preserves headingPre front matter and inserts the ad unless disabled.
• Bottom ads render in layouts/partials/content.html unless disabled.
• Ad units read from params.adsense in config.toml:

[params.adsense]
  client = "ca-pub-2093481943685202"
  topSlot = "YOUR_TOP_SLOT_ID"
  bottomSlot = "YOUR_BOTTOM_SLOT_ID"

• Disable ads per page with front matter:

headingPre: "<span>Optional custom HTML before the title</span>"
disableTopAd: true
disableBottomAd: true

Download Hugo 0.147.7 into tools/hugo (macOS):

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

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

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

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

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

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