digital library software
Find a file
2026-01-31 15:34:25 -06:00
sass made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
tpl made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
.dockerignore implement config file 2023-06-15 14:11:42 -05:00
.editorconfig made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
.gitignore made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
config.go embed static & template files and allow overloading 2025-09-07 15:28:34 -05:00
dev.sh improve filtering system, compile css from sass 2025-06-24 12:26:32 -05:00
docker-compose.yml Update Dockerfile and docker-compose.yml 2025-03-15 16:35:17 -05:00
Dockerfile Update Dockerfile and docker-compose.yml 2025-03-15 16:35:17 -05:00
example.config.yml stuff 2025-03-14 13:06:37 -05:00
flake.lock improve filtering system, compile css from sass 2025-06-24 12:26:32 -05:00
flake.nix made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
go.mod made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
go.sum made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
http.go made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
main.go add catalog sorting 2025-09-08 12:07:15 -05:00
README.md resolve catalog URLs 2025-03-15 11:50:21 -05:00
template.go made progress on entry editor, updated style 2026-01-31 15:29:10 -06:00
TODO.md update notes 2026-01-31 15:34:25 -06:00
util.go rename some stuff 2025-09-08 14:50:05 -05:00

site sections

zines and other literature

route: /catalogue

  • list zines, books, articles, and pretty much anything else that a browser can handle
  • encourage supporting the authors by prominently displaying source links
  • use tags to create categorical filters

catalogue.yml example:

- title: The Content Piece's Title
  author: Author Name
  description: >
    You can use a pipe | or a greater-than symbol > to write YAML strings across multiple lines.
    See https://yaml-multiline.info for details.
  type: zine | book | article | ...or whatever you want
  tags:
    - foo
    - bar
  image: ContentPiece.jpg  # file paths are relative to data/lib/files/
  image_class: banner | portrait
  href: ContentPiece.pdf  # the primary link that the image/title anchor points to
  links:  # extra links off to the side
    epub: ContentPiece.epub
    source: https://zine.website/
  • links are grouped into related sections
  • each group of links is shuffled

hyperlinks.yml example:

- name: Section title
  description: This is a group of links under a related banner.
  links:
    - url: https://website.org/page.htm
    - url: https://example.com
      name: Super duper cool website

- name: Group two
  description: This is another group of links!
  links:
    - ...

server configuration

copy example.config.yml to config.yml next to the executable (or set $XANADU_CONFIG to its path) and make changes as needed.

design

  • tiny web, maximizing browser compatibility by being smol
  • mobile and desktop are equally important
  • ascii art is wrapped in <pre/> tags with alt-text for accessibility

name meaning

a reference to: