From 9bf0f0ce1b18b38c37bbc4d576228a76b84f6b41 Mon Sep 17 00:00:00 2001 From: Gerry Shaw Date: Sun, 27 Sep 2026 12:59:59 -0700 Subject: [PATCH] Ruby 4.0.7, checks, CI, agent docs and content fixes - Ruby 4.0.7 and a fresh Gemfile.lock (Bundler 4.0.20, Linux and macOS). - mise tasks for build, spell, markdownlint, links, check and verify; GitHub Actions runs `mise run -c check`. - AGENTS.md with CLAUDE.md importing it; README uses mise. - Layout reads title, icon, start year and author from _config.yml; head adds description, canonical and Open Graph tags; lang="en". - Fix typos, stale iOS and release claims, and heading levels. 404 page gets a home link. Remove unused scale.fix.js and the justfile exclude. Closes #1, closes #2, closes #3. Co-Authored-By: Claude Opus 5.5 (1M context) --- .github/workflows/ci.yml | 23 +++++ .gitignore | 15 +++ .markdownlint-cli2.yaml | 5 + .markdownlint.yaml | 3 + .mise.toml | 39 +++++++- 404.md | 3 +- AGENTS.md | 67 +++++++++++++ CLAUDE.md | 1 + Gemfile | 2 +- Gemfile.lock | 204 ++++++++++++++++++++++++++++++++++----- README.md | 32 +++--- _config.yml | 13 ++- _includes/head.html | 21 ++-- _layouts/page.html | 10 +- cspell.config.yaml | 20 ++++ index.md | 8 +- javascripts/scale.fix.js | 21 ---- privacy.md | 6 +- support.md | 6 +- 19 files changed, 404 insertions(+), 95 deletions(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .markdownlint-cli2.yaml create mode 100644 .markdownlint.yaml create mode 100644 AGENTS.md create mode 100644 CLAUDE.md create mode 100644 cspell.config.yaml delete mode 100644 javascripts/scale.fix.js diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..b23a03b --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,23 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v6 + + - uses: jdx/mise-action@v4 + + - run: bundle install + + # -c keeps going after a failure so one run shows every problem. + - name: Check + env: + MISE_TASK_OUTPUT: interleave + run: mise run -c check diff --git a/.gitignore b/.gitignore index ca35be0..f4794cb 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,16 @@ +# Jekyll build output and caches _site +.jekyll-cache +.jekyll-metadata + +# Bundler +.bundle +vendor/bundle + +# Editor and agent tooling +.vscode +.ruby-lsp +.claude + +# macOS +.DS_Store diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..380d0a9 --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,5 @@ +ignores: + - "_site/**" + - "vendor/**" + - ".claude/**" + - "CLAUDE.md" # import shim (@AGENTS.md), not prose diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..b203f9f --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,3 @@ +MD013: false # line-length +MD025: false # single-title/single-h1: Jekyll pages put the title in front matter +MD033: false # no-inline-html: pages embed images, video and badges as HTML diff --git a/.mise.toml b/.mise.toml index be5ec48..46bc919 100644 --- a/.mise.toml +++ b/.mise.toml @@ -1,14 +1,43 @@ [tools] -ruby = "3.2.2" # Cloudflare Build System version 2 using Ruby 3.2.2 +ruby = "4.0.7" +node = "24.4.1" +"npm:cspell" = "9.1.5" +"npm:markdownlint-cli2" = "0.22.1" +"gem:html-proofer" = "5.2.1" [tasks.install] run = "bundle install" [tasks.dev] -run = "bundle exec jekyll serve --livereload --open-url --port 4002" +run = "bundle exec jekyll serve --livereload --livereload-port 35702 --open-url --port 4002" + +[tasks.build] +run = "bundle exec jekyll build --quiet" + +[tasks.spell] +run = "cspell lint --no-progress ." + +[tasks.markdownlint] +run = """ +out=$(markdownlint-cli2 '**/*.md' 2>&1) && echo "Markdown lint passed" || { echo "$out"; exit 1; } +""" + +# Internal links only. External sites rate-limit and flake; check them by hand +# with `htmlproofer _site` when it matters. +[tasks.links] +depends = ["build"] +run = "htmlproofer _site --disable-external --no-check-internal-hash" + +[tasks.check] +depends = ["spell", "markdownlint", "links"] + +# Run after a deploy lands. Cloudflare Pages builds on push to main. +[tasks.verify] +run = """ +curl -fsS https://birdsnearme.com/ | grep -q "Birds Near Me" && echo "birdsnearme.com is up" +test "$(curl -s -o /dev/null -w '%{http_code}' https://birdsnearme.com/no-such-page/)" = 404 && echo "404 page works" +""" [tasks.deploy] +depends = ["check"] run = "git push" - -[settings] -experimental = true diff --git a/404.md b/404.md index 967eac7..a3f26dd 100755 --- a/404.md +++ b/404.md @@ -1,5 +1,6 @@ --- title: 404 Not Found +permalink: /404.html --- -You are at a page that doesn't exist. +You are at a page that doesn't exist. [Go home?](/) diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..ea2d8a2 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,67 @@ +# Agent Notes + +<!-- cspell:ignore birdsnearme -- the domain and Cloudflare Pages project name --> + +Background for AI agents working in this repo. + +## What this is + +The marketing site for Birds Near Me, a worldwide birding field guide for iPhone built on +eBird data, live at [birdsnearme.com](https://birdsnearme.com). A Jekyll site on Cloudflare +Pages. The app itself lives in a separate repo, `BirdsNearMe`. + +**The repo and the site are both public.** Anything committed here is published. + +Keep it minimal. Don't add gems, plugins, pages or build steps unless asked. + +## Commands + +```sh +mise run install # bundle install +mise run dev # serve on :4002 with livereload +mise run check # build + spell + markdownlint + internal links +mise run verify # curl the live site after a deploy +mise run deploy # check, then git push +``` + +**Read the counts, not just the exit code.** html-proofer prints `Ran on N files` and cspell +prints `Files checked: N`. A green run over zero files checked nothing. + +## Deploys + +Cloudflare Pages project `birdsnearme-website` builds every push. `main` goes to +production; other branches get a preview URL. The build runs `bundle exec jekyll build` +with `RUBY_VERSION` set in the Cloudflare project, so a Ruby bump means changing `Gemfile`, +`.mise.toml` and that variable together. + +GitHub Actions runs `mise run -c check` on pushes and PRs. It doesn't block Cloudflare. + +## Layout + +- `_config.yml` holds the site name, description, icon, copyright start year and author. + The layout reads them; don't hard-code them in HTML. +- `_layouts/page.html` is the only layout. `_includes/head.html` has the meta and Open Graph + tags; a page can override the description with `description:` and the preview image with + `ogimage:` in front matter. +- `index.md`, `support.md`, `privacy.md`, `404.md`. +- `pico.min.css` is Pico 1.5, copied in rather than loaded from a CDN. + +## Writing + +- Claims must match the released app on the App Store, not the rewrite in the app repo. + In September 2026 that was version 1.5 (March 2019), which needs iOS 10 or later. Update + `index.md` and `support.md` when a new version ships. +- The app's data comes from eBird, Flickr, Wikipedia and xeno-canto. Keep the + acknowledgements and the privacy policy in step with that list. + +## Suppressions + +Suppress a check inline, with a reason, in the file that provoked it: +`<!-- cspell:ignore word -->` or `<!-- markdownlint-disable-next-line MD0xx -->`. Move a +word to `cspell.config.yaml` only once a second file needs it. + +## Branches, issues and PRs + +- Branch names are flat and short: `<issue>-<slug>`, no `claude/` prefix. +- Issue and PR bodies aren't hard-wrapped. +- Squash-merge only. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/Gemfile b/Gemfile index f4eee3e..ef4510c 100644 --- a/Gemfile +++ b/Gemfile @@ -1,4 +1,4 @@ -ruby "3.2.2" +ruby "4.0.7" source "https://rubygems.org" diff --git a/Gemfile.lock b/Gemfile.lock index 67b7fe3..e1af3d7 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,24 +1,58 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.8.7) - public_suffix (>= 2.0.2, < 7.0) - base64 (0.2.0) - bigdecimal (3.1.9) + addressable (2.9.0) + public_suffix (>= 2.0.2, < 8.0) + base64 (0.3.0) + bigdecimal (4.1.3) colorator (1.1.0) - concurrent-ruby (1.3.5) - csv (3.3.3) + concurrent-ruby (1.3.8) + csv (3.3.6) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.17.1-arm64-darwin) + ffi (1.17.4) + ffi (1.17.4-aarch64-linux-gnu) + ffi (1.17.4-aarch64-linux-musl) + ffi (1.17.4-arm-linux-gnu) + ffi (1.17.4-arm-linux-musl) + ffi (1.17.4-arm64-darwin) + ffi (1.17.4-x86-linux-gnu) + ffi (1.17.4-x86-linux-musl) + ffi (1.17.4-x86_64-darwin) + ffi (1.17.4-x86_64-linux-gnu) + ffi (1.17.4-x86_64-linux-musl) forwardable-extended (2.6.0) - google-protobuf (4.30.2-arm64-darwin) + google-protobuf (4.36.2) bigdecimal - rake (>= 13) - http_parser.rb (0.8.0) - i18n (1.14.7) + rake (~> 13.3) + google-protobuf (4.36.2-aarch64-linux-gnu) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-aarch64-linux-musl) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-arm64-darwin) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-x86-linux-gnu) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-x86-linux-musl) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-x86_64-darwin) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-x86_64-linux-gnu) + bigdecimal + rake (~> 13.3) + google-protobuf (4.36.2-x86_64-linux-musl) + bigdecimal + rake (~> 13.3) + http_parser.rb (0.8.1) + i18n (1.15.2) concurrent-ruby (~> 1.0) jekyll (4.4.1) addressable (~> 2.4) @@ -43,35 +77,86 @@ GEM sass-embedded (~> 1.75) jekyll-watch (2.2.1) listen (~> 3.0) - json (2.10.2) - kramdown (2.5.1) - rexml (>= 3.3.9) + json (2.21.2) + kramdown (2.5.2) + rexml (>= 3.4.4) kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.9.0) + listen (3.10.0) + logger rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) + logger (1.7.0) mercenary (0.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (6.0.1) - rake (13.2.1) + public_suffix (7.0.5) + rake (13.4.2) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.4.1) - rouge (4.5.1) + rexml (3.4.4) + rouge (4.7.0) safe_yaml (1.0.5) - sass-embedded (1.86.2-arm64-darwin) - google-protobuf (~> 4.30) + sass-embedded (1.105.0) + google-protobuf (~> 4.31) + rake (~> 13.3) + sass-embedded (1.105.0-aarch64-linux-android) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-aarch64-linux-gnu) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-aarch64-linux-musl) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-arm-linux-androideabi) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-arm-linux-gnueabihf) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-arm-linux-musleabihf) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-arm64-darwin) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-riscv64-linux-android) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-riscv64-linux-gnu) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-riscv64-linux-musl) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-x86_64-darwin) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-x86_64-linux-android) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-x86_64-linux-gnu) + google-protobuf (~> 4.31) + sass-embedded (1.105.0-x86_64-linux-musl) + google-protobuf (~> 4.31) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) unicode-display_width (2.6.0) - webrick (1.9.1) + webrick (1.9.2) PLATFORMS - arm64-darwin-24 + aarch64-linux-android + aarch64-linux-gnu + aarch64-linux-musl + arm-linux-androideabi + arm-linux-gnu + arm-linux-gnueabihf + arm-linux-musl + arm-linux-musleabihf + arm64-darwin + arm64-darwin-23 + riscv64-linux-android + riscv64-linux-gnu + riscv64-linux-musl + ruby + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux + x86_64-linux-android + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES base64 @@ -80,8 +165,77 @@ DEPENDENCIES jekyll webrick (~> 1.8) +CHECKSUMS + addressable (2.9.0) sha256=7fdf6ac3660f7f4e867a0838be3f6cf722ace541dd97767fa42bc6cfa980c7af + base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b + bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66 + colorator (1.1.0) sha256=e2f85daf57af47d740db2a32191d1bdfb0f6503a0dfbc8327d0c9154d5ddfc38 + concurrent-ruby (1.3.8) sha256=b2f1be836e968ccc78ccfce277ea79c72a88633f22306782c16ff23fb415d1e1 + csv (3.3.6) sha256=aba61e7e507a66f03d45cb1f3c4b6359861c3504038b422962875dce099e4456 + em-websocket (0.5.3) sha256=f56a92bde4e6cb879256d58ee31f124181f68f8887bd14d53d5d9a292758c6a8 + eventmachine (1.2.7) sha256=994016e42aa041477ba9cff45cbe50de2047f25dd418eba003e84f0d16560972 + ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf + ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df + ffi (1.17.4-aarch64-linux-musl) sha256=9286b7a615f2676245283aef0a0a3b475ae3aae2bb5448baace630bb77b91f39 + ffi (1.17.4-arm-linux-gnu) sha256=d6dbddf7cb77bf955411af5f187a65b8cd378cb003c15c05697f5feee1cb1564 + ffi (1.17.4-arm-linux-musl) sha256=9d4838ded0465bef6e2426935f6bcc93134b6616785a84ffd2a3d82bc3cf6f95 + ffi (1.17.4-arm64-darwin) sha256=19071aaf1419251b0a46852abf960e77330a3b334d13a4ab51d58b31a937001b + ffi (1.17.4-x86-linux-gnu) sha256=38e150df5f4ca555e25beca4090823ae09657bceded154e3c52f8631c1ed72cf + ffi (1.17.4-x86-linux-musl) sha256=fbeec0fc7c795bcf86f623bb18d31ea1820f7bd580e1703a3d3740d527437809 + ffi (1.17.4-x86_64-darwin) sha256=aa70390523cf3235096cf64962b709b4cfbd5c082a2cb2ae714eb0fe2ccda496 + ffi (1.17.4-x86_64-linux-gnu) sha256=9d3db14c2eae074b382fa9c083fe95aec6e0a1451da249eab096c34002bc752d + ffi (1.17.4-x86_64-linux-musl) sha256=3fdf9888483de005f8ef8d1cf2d3b20d86626af206cbf780f6a6a12439a9c49e + forwardable-extended (2.6.0) sha256=1bec948c469bbddfadeb3bd90eb8c85f6e627a412a3e852acfd7eaedbac3ec97 + google-protobuf (4.36.2) sha256=2f8daff50ae14aad36ab0ccdcf284065fa71d726c444efe114e6db82ffe62494 + google-protobuf (4.36.2-aarch64-linux-gnu) sha256=c3279ec6eaa59f6ed6276eda2a33cffb4306471183ab79a332e698b8564f5169 + google-protobuf (4.36.2-aarch64-linux-musl) sha256=0772c9dde1e6dce9a6b44d1d35c28c29adee99d9bd6aff5e21840daeb22161ce + google-protobuf (4.36.2-arm64-darwin) sha256=f70d810e6bbab9d8ad9c1d5fd685a21de4c10ad3ad32efb9455e17e5b1286917 + google-protobuf (4.36.2-x86-linux-gnu) sha256=ffcd06d49bffca24afff18c900dd61a51ea3028d43c47d0d9621d00bf38a5866 + google-protobuf (4.36.2-x86-linux-musl) sha256=e1afec03babd73c9117cc09d5fc2a98dfef37a414bfd8a4d0ceaac7bd66fc028 + google-protobuf (4.36.2-x86_64-darwin) sha256=8d1bd2a344f7f589703b202ad2ee4cca8ef731b4ced45782ef92d385967384ba + google-protobuf (4.36.2-x86_64-linux-gnu) sha256=d25a820873e423f1d209ae8c672a4a28b019e2429debd0901d26670a0b4e14db + google-protobuf (4.36.2-x86_64-linux-musl) sha256=0fa17686c896da96a60a705e56ddc7d4ff56413f52787c655bd4c9fb33ffe14f + http_parser.rb (0.8.1) sha256=9ae8df145b39aa5398b2f90090d651c67bd8e2ebfe4507c966579f641e11097a + i18n (1.15.2) sha256=00f9eb62412fe593b2a65a97daa75300d37abb8f7202ec748e94b6d46a9dd1b5 + jekyll (4.4.1) sha256=4c1144d857a5b2b80d45b8cf5138289579a9f8136aadfa6dd684b31fe2bc18c1 + jekyll-sass-converter (3.1.0) sha256=83925d84f1d134410c11d0c6643b0093e82e3a3cf127e90757a85294a3862443 + jekyll-watch (2.2.1) sha256=bc44ed43f5e0a552836245a54dbff3ea7421ecc2856707e8a1ee203a8387a7e1 + json (2.21.2) sha256=1f1d3b7cf2b3ba1a69beca0bb6db13d5438b80bff3cd54cdaaa620b9b07c1c6a + kramdown (2.5.2) sha256=1ba542204c66b6f9111ff00dcc26075b95b220b07f2905d8261740c82f7f02fa + kramdown-parser-gfm (1.1.0) sha256=fb39745516427d2988543bf01fc4cf0ab1149476382393e0e9c48592f6581729 + liquid (4.0.4) sha256=4fcfebb1a045e47918388dbb7a0925e7c3893e58d2bd6c3b3c73ec17a2d8fdb3 + listen (3.10.0) sha256=c6e182db62143aeccc2e1960033bebe7445309c7272061979bb098d03760c9d2 + logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203 + mercenary (0.4.0) sha256=b25a1e4a59adca88665e08e24acf0af30da5b5d859f7d8f38fba52c28f405138 + pathutil (0.16.2) sha256=e43b74365631cab4f6d5e4228f812927efc9cb2c71e62976edcb252ee948d589 + public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623 + rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701 + rb-fsevent (0.11.2) sha256=43900b972e7301d6570f64b850a5aa67833ee7d87b458ee92805d56b7318aefe + rb-inotify (0.11.1) sha256=a0a700441239b0ff18eb65e3866236cd78613d6b9f78fea1f9ac47a85e47be6e + rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142 + rouge (4.7.0) sha256=dba5896715c0325c362e895460a6d350803dbf6427454f49a47500f3193ea739 + safe_yaml (1.0.5) sha256=a6ac2d64b7eb027bdeeca1851fe7e7af0d668e133e8a88066a0c6f7087d9f848 + sass-embedded (1.105.0) sha256=322f46df344e5d974fc808fa2a6fe973a02932c21545402a25ac5b7aee62ff5f + sass-embedded (1.105.0-aarch64-linux-android) sha256=1153c80152059a0c7b9c1a1f2fed7c527f2d06d6c7ffd2a5b2212283ef5cf3e5 + sass-embedded (1.105.0-aarch64-linux-gnu) sha256=26dc2b0f8063f99ad4df226ebecac361c52ce06c63d8acc20ebc615d1450ea09 + sass-embedded (1.105.0-aarch64-linux-musl) sha256=f74817c6d12cd63ce8b479844b2a791c68dca69500808925276f19bab875c072 + sass-embedded (1.105.0-arm-linux-androideabi) sha256=6ccb0ed5710098a6d3df68567d270c04d659a9c69233cc6455fbb7d0aa399d89 + sass-embedded (1.105.0-arm-linux-gnueabihf) sha256=32562783fcddcb83f1530b079c2920acffea40affc7bbbde4e0434fb5eb44b1b + sass-embedded (1.105.0-arm-linux-musleabihf) sha256=b1e766f2d95a8e08446640013fa00d8b006fe1679c7adabc54f3e9cd09aaa6a0 + sass-embedded (1.105.0-arm64-darwin) sha256=c9a7bdcf976b03c7a420df25de1ce39255cc8c9776117ea20bcf0fe7cbadee3f + sass-embedded (1.105.0-riscv64-linux-android) sha256=7b1f3ba3b2eab5ee45dc028f892685481f18c05e04eb2e0e107f28eee068c03e + sass-embedded (1.105.0-riscv64-linux-gnu) sha256=d0ac6793b8af67c43a7b9976d5c42869fd728b7300d212718b263437ff724e5d + sass-embedded (1.105.0-riscv64-linux-musl) sha256=1874212cd688b52726d4bad085794ba348c230187761807d18fa381eb3b13f14 + sass-embedded (1.105.0-x86_64-darwin) sha256=4e2d4238f8e286e0b256b63d3713ad27a06542b3079087e54d2c169072fb77fa + sass-embedded (1.105.0-x86_64-linux-android) sha256=893c960a3456645dc8d810266577eb5410e2665460617146ab63d4bdcda14de9 + sass-embedded (1.105.0-x86_64-linux-gnu) sha256=c7cb4884c6d1ddad41d52f5950167d5cf77e242d7900ca0ec13170ba43878977 + sass-embedded (1.105.0-x86_64-linux-musl) sha256=fbbda8c5df1073e177382cccd8c640ed7f49553e040713cd7fffca1af194cf96 + terminal-table (3.0.2) sha256=f951b6af5f3e00203fb290a669e0a85c5dd5b051b3b023392ccfd67ba5abae91 + unicode-display_width (2.6.0) sha256=12279874bba6d5e4d2728cef814b19197dbb10d7a7837a869bab65da943b7f5a + webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131 + RUBY VERSION - ruby 3.2.2p53 + ruby 4.0.7 BUNDLED WITH - 2.4.19 + 4.0.20 diff --git a/README.md b/README.md index 00c4e42..3ef9352 100755 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ # Birds Near Me website -[Live Site](https://birdsnearme.com) +[https://birdsnearme.com](https://birdsnearme.com) -### Build Instructions +## Develop +```sh +mise install # Ruby, Node, cspell, markdownlint, html-proofer +mise run install # bundle install +mise run dev # http://localhost:4002 with livereload +mise run check # build, spell check, markdown lint, internal links ``` -brew install asdf -asdf list -asdf plugin add ruby -asdf plugin-update ruby -asdf list all ruby -asdf install ruby latest -asdf global ruby 3.2.2 # change specfic version to latest stable -gem install bundler -bundle add webrick # https://github.com/jekyll/jekyll/issues/8523 -brew install just -just -l -just install -just start -``` +Pushing to `main` publishes the site on Cloudflare Pages. `mise run verify` checks the live site afterwards. + +## Powered By -Pushing to GitHub will publish the site. +- Domain Registrar: [Cloudflare Registrar](https://www.cloudflare.com/products/registrar/) +- DNS: [Cloudflare DNS](https://www.cloudflare.com/dns/) +- Hosting: [Cloudflare Pages](https://pages.cloudflare.com) +- Build System: [Jekyll](https://jekyllrb.com) +- CSS: [Pico.css](https://picocss.com) diff --git a/_config.yml b/_config.yml index fbdd61c..147517b 100755 --- a/_config.yml +++ b/_config.yml @@ -2,9 +2,12 @@ title: Birds Near Me description: Worldwide birding field guide for iOS. Free. No ads. Privacy respected. url: https://birdsnearme.com +icon: /icon.png +start_year: 2014 author: name: Gerry Shaw email: gerry_shaw@yahoo.com + url: https://gshaw.ca # Build settings markdown: kramdown @@ -13,16 +16,18 @@ kramdown: input: GFM exclude: [ + "AGENTS.md", + "CLAUDE.md", + "cspell.config.yaml", "Gemfile", "Gemfile.lock", - "justfile", "LICENSE", - "README.md" + "README.md", + "vendor" ] defaults: - - - scope: + - scope: path: "" type: "pages" values: diff --git a/_includes/head.html b/_includes/head.html index 6ba20b2..f673aff 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,9 +1,17 @@ <head> - <meta charset="UTF-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - {% if page.ogimage and page.ogimage != '' %} - <meta property="og:image" content="{{ page.ogimage }}" /> - {% endif %} + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>{{ page.title }} + {% assign description = page.description | default: site.description -%} + {% comment %}Cloudflare Pages serves /privacy.html at /privacy.{% endcomment -%} + {% assign canonical = page.url | remove: ".html" | absolute_url -%} + + + + + + + @@ -17,5 +25,4 @@ margin-bottom: 0.2em } - {{ page.title }} - \ No newline at end of file + diff --git a/_layouts/page.html b/_layouts/page.html index fd8b1fb..af37df4 100755 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -1,5 +1,5 @@ - + {% include head.html %} @@ -7,7 +7,7 @@

- Birds Near Me app icon + {{ site.title }} app icon {{ page.title }}

@@ -17,15 +17,15 @@


- Birds Near Me + {{ site.title }} • Support • Privacy Policy • - © 2014-{{ 'now' | date: "%Y" }} Gerry Shaw + © {{ site.start_year }} - {{ 'now' | date: "%Y" }} {{ site.author.name }}

- \ No newline at end of file + diff --git a/cspell.config.yaml b/cspell.config.yaml new file mode 100644 index 0000000..0b1c331 --- /dev/null +++ b/cspell.config.yaml @@ -0,0 +1,20 @@ +$schema: "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json" +version: "0.2" +language: en +allowCompoundWords: true +ignorePaths: + - ".git" + - ".claude" + - "_site" + - ".jekyll-cache" + - "vendor" + - "Gemfile.lock" + - "pico.min.css" +words: + - gshaw + - kramdown + - ogimage # front matter key for the Open Graph image + - pico + - qrcode + - flickr # photo source for the app + - xeno # xeno-canto, recordings source for the app diff --git a/index.md b/index.md index cb882a3..007e7e9 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,8 @@ title: Birds Near Me ogimage: /icon.png --- + + Worldwide birding field guide for iOS. Free. No ads. Privacy respected. Screenshot of Birds Near Me @@ -13,16 +15,16 @@ The bird guide for everybody everywhere in the world. Find what birds are near y Powered by eBird to provide an accurate list of birds that have been recently spotted in your exact area. -### Features +## Features - Search for pictures, songs, sightings and information on more than 10,000 birds from across the entire world - Birding hotspots around the globe - Specific filter for notable sightings near you - View a custom list of recent bird sightings near your location -- Supports iOS 8+ +- Supports iOS 10 and later - Designed and developed by a birder, for birders -### Acknowledgements +## Acknowledgements - [eBird](https://ebird.org) and all the birders for contributing their sightings - [Flickr](https://www.flickr.com/search/?q=birding) and photographers for sharing their photos diff --git a/javascripts/scale.fix.js b/javascripts/scale.fix.js deleted file mode 100644 index 0978a0e..0000000 --- a/javascripts/scale.fix.js +++ /dev/null @@ -1,21 +0,0 @@ -// Used by app to adjust checklist webview - -var metas = document.getElementsByTagName("meta"); -var i; -if (navigator.userAgent.match(/iPhone/i)) { - for (i = 0; i < metas.length; i++) { - if (metas[i].name == "viewport") { - metas[i].content = - "width=device-width, minimum-scale=1.0, maximum-scale=1.0"; - } - } - document.addEventListener("gesturestart", gestureStart, false); -} -function gestureStart() { - for (i = 0; i < metas.length; i++) { - if (metas[i].name == "viewport") { - metas[i].content = - "width=device-width, minimum-scale=0.25, maximum-scale=1.6"; - } - } -} diff --git a/privacy.md b/privacy.md index fc982c8..832e37a 100644 --- a/privacy.md +++ b/privacy.md @@ -8,10 +8,10 @@ Your privacy is important. This Privacy Policy describes how your personal infor The app "Birds Near Me" uses eBird, Flickr, Wikipedia and Xeno-Canto so all of these sites will see what you are browsing as you use the app. If this is a problem for you then you should delete the app. -Google Analytics tracking was removed the app in version 1.5 released in March 2019 and will stay removed in all future versions. +Google Analytics tracking was removed from the app in version 1.5 released in March 2019 and will stay removed in all future versions. -Google Analytics tracking was removed this website in May 2023 and will stay removed. No analytcis or tracking is performed on the website. +Google Analytics tracking was removed from this website in May 2023 and will stay removed. No analytics or tracking is performed on the website. This app is not motivated by advertising or commercial gain. I built it for myself and to share with the birding community in a way to give back for all that others have done for birds. -If you have any questions about this Privacy Policy, feel free to get in touch with me at gerry_shaw@yahoo.com +If you have any questions about this Privacy Policy, feel free to get in touch with me at [gerry_shaw@yahoo.com](mailto:gerry_shaw@yahoo.com). diff --git a/support.md b/support.md index f2588aa..cfc1b94 100644 --- a/support.md +++ b/support.md @@ -4,10 +4,10 @@ title: Birds Near Me Support If you have any questions I'll try my best to quickly answer them by email at [gerry_shaw@yahoo.com](mailto:gerry_shaw@yahoo.com?subject=[Birds Near Me Support]) -### Frequently Asked Questions +## Frequently Asked Questions 1. **Is there an Android version?** Not at this time and unlikely in near future. -2. **The app crashes when playing recordings.** This is a known issue and will be fixed in the next release. Something must have happened with the API or newer iOS verions that caused this. I'm having the same issues myself. +2. **The app crashes when playing recordings.** This is a known issue in version 1.5, likely caused by changes to the recordings API or newer iOS versions. There is no fix date yet. -3. **When will the next release be?** Unfortunately this is hobby project of mine and since the app is given away it's hard to prioritize this over other other. Hopefully soon. +3. **When will the next release be?** There is no date yet. This is a hobby project of mine and since the app is given away it's hard to prioritize over other work.