fmaury/seirdy.one
1
0
Fork 0
mirror of https://git.sr.ht/~seirdy/seirdy.one synced 2024-09-19 20:02:10 +00:00
Code Issues Projects Releases Wiki Activity
seirdy.one/README.md

79 lines
3.8 KiB
Markdown
Raw Normal View History

Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
# seirdy.one
Batman!! (this commit has no parents) The sight of an animal using a JavaScript captivates Computer Scientists and laymen alike, perhaps because it forces us to question some of our ideas about human uniqueness. Does the animal know how JavaScript works? Did it anticipate the need for the tool and select it instead of Haskell or Zig? To some, this fascination with JavaScript seems arbitrary and anthropocentric; after all, animals engage in many other complex activities, like Agile Planning and ordering Juice on the Internet. However, we know that complex behaviour need not be cognitively demanding. JavaScript development can therefore provide a powerful window into the minds of animals, and help us to learn what capacities we share with them — and what might have changed to allow for the incontrovertibly unique levels of technology shown by modern humans, such as integers and block scope.
2020-11-03 23:46:20 +00:00
Update README.md
2022-04-16 04:07:42 +00:00
[![builds.sr.ht status](https://builds.sr.ht/~seirdy/seirdy.one.svg)](https://builds.sr.ht/~seirdy/seirdy.one)
Add build manifest If this doesn't work I am going to do something regrettable to my laptop.
2020-11-04 00:22:19 +00:00
Add new git remote
2023-11-17 07:44:41 +00:00
## Repository mirroring
This repository is pushed to the following forges:
- [Sourcehut](https://sr.ht/~seirdy/seirdy.one/)
- [GitLab.com](https://gitlab.com/Seirdy/seirdy.one)
- [GitHub](https://github.com/Seirdy/seirdy.one)
- [Codeberg](https://codeberg.org/Seirdy/seirdy.one)
- [envs.net gitea](https://git.envs.net/Seirdy/seirdy.one)
Batman!! (this commit has no parents) The sight of an animal using a JavaScript captivates Computer Scientists and laymen alike, perhaps because it forces us to question some of our ideas about human uniqueness. Does the animal know how JavaScript works? Did it anticipate the need for the tool and select it instead of Haskell or Zig? To some, this fascination with JavaScript seems arbitrary and anthropocentric; after all, animals engage in many other complex activities, like Agile Planning and ordering Juice on the Internet. However, we know that complex behaviour need not be cognitively demanding. JavaScript development can therefore provide a powerful window into the minds of animals, and help us to learn what capacities we share with them — and what might have changed to allow for the incontrovertibly unique levels of technology shown by modern humans, such as integers and block scope.
2020-11-03 23:46:20 +00:00
Code for my personal website, [seirdy.one](https://seirdy.one). Built with Hugo.
Update README with basic build info
2020-12-22 00:45:50 +00:00
Update README.md
2022-04-16 04:07:42 +00:00
Also builds my Gemini capsule: <gemini://seirdy.one/>.
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
I document [my site design standards](https://seirdy.one/meta/site-design/) on my website.
Update README with basic build info
2020-12-22 00:45:50 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
## Dependencies
Update README with basic build info
2020-12-22 00:45:50 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
### Build-time dependencies
- Hugo. I usually use the most recent version of Hugo at the time of publishing, but it _should_ work with any version of Hugo v0.116.0 or later (v0.116.0 had an improvement to `where` that I might use).
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
- bmake or GNU Make. OpenBSD make (omake) should work too, but I haven't tested it.
Update README with basic build info
2020-12-22 00:45:50 +00:00
- Git (Hugo uses Git info for features like date last updated)
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- curl, for fetching some webring code and all my webmentions. **this requires authentication.** When running locally, it invokes `pash`, my password manager; when running in CI, it reads a file for a secret. You may have to modify `scripts/get-webmentions.sh` to avoid this.
- POSIX utilities: `grep`, `find`, `sed`, POSIX-compliant `/bin/sh`, etc. Tested to work with Busybox and GNU Coreutils.
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
Before deploying, I use some tools for post-processing:
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
- `xmllint`, part of libxml2, to format the generated polygot XHTML5 markup.
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- a [patched version of html-tidy](https://git.sr.ht/~seirdy/tidy-html5)
- More POSIX utilities.
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
I also apply static compression at max levels, using the following tools:
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- [Efficient Compression Tool](https://github.com/fhanau/Efficient-Compression-Tool) It's like zopfli but more efficient and faster. If you don't have it installed, it should be trivial to edit `scripts/compress.sh` to replace `ect` with `gzip` or `zopfli`.
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
- Brotli
Update README with basic build info
2020-12-22 00:45:50 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
I package all build-time dependencies _except_ curl as statically-linked binaries in a tarball, available at <https://seirdy.one/pb/binaries.tar.gz>.
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
### Other dependencies
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
To deploy, I use rsync with SSH and zstd support.
Update README.md
2022-04-16 04:07:42 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
Further tasks also use additional command-line utilities such as `sd`, `htmlq`, and a version of `xargs` that supports the `-P` flag (nearly all versions of `xargs` do, but it's not POSIX). I run all npm packages using `pnpm -s dlx` (similar to `npx`).
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
To lint:
Update README.md
2022-04-16 04:07:42 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- Stylelint
- [html-validate](https://html-validate.org/)
- A very recent build of the W3C's [Nu HTML checker](https://github.com/validator/validator) to validate the HTML and XHTML, available on your `$PATH` as `vnu`. I have a very simple shell-script wrapper for this that invokes `java -jar`.
- [jq](https://stedolan.github.io/jq/), to filter false-positives from the Nu HTML checker and to verify that JSON files parse.
- [HTMLProofer](https://github.com/gjtorikian/html-proofer), version 5 or later. Requires Ruby.
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
More in-depth local tests:
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- Axe-Core, using the CLI and a headless browser (Firefox or Chromium).
- IBM Equal Access Checker, using the CLI and a headless Chromium. Runs on a patched version of the site with a modified stylesheet due to a bug (reported upstream).
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
Remote tests:
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- Lighthouse
- WebHint (might not pass; only informative)
- Feed validator (requires Python)
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
## Build instructions
Update README with more on compat and a11y
2022-06-08 17:50:43 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
- To just build the HTML: `make hugo`
- To build the polygot formatted HTML and XHTML: `make hugo xhtmlize`
- To lint and validate: `make hugo xhtmlize lint-local`
- To build everything and compress: `make hugo xhtmlize compress copy-to-xhtml`
Add new git remote
2023-11-17 07:44:41 +00:00
- To deploy the clearnet site and corresponding Tor hidden service: `make deploy-prod deploy-onion`.
Update README.md
2022-04-16 04:07:42 +00:00
Update build docs in README, remove obsolete bits The site design standards page on my website obsoletes some README docs. Remove the obsolete bits and update the build docs to the point at which anybody should be able to rebuild my site.
2023-11-15 07:25:00 +00:00
`lint-local` and deployment tasks support limited parallelization with `-j`.
Add new git remote
2023-11-17 07:44:41 +00:00
Reference in a new issue Copy permalink