a free digital library
data | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
config.go | ||
dev.sh | ||
docker-compose.yml | ||
Dockerfile | ||
example.config.yml | ||
go.mod | ||
go.sum | ||
http.go | ||
main.go | ||
README.md | ||
template.go | ||
TODO.md | ||
util.go |
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 to cool things on the web
route: /hyperlinks
- 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:
- Project Xanadu (also referenced in SEL)
- X.A.N.A. from Code Lyoko, which references [Citizen Kane](https://en.wikipedia.org/wiki/Xanadu_(Citizen_Kane), which references Kubla Khan.
- "Xanadu" is a pretty bad transliteration of Shangdu, the summer capital city of the Yuan Dynasty in medieval China. blame the English for that spelling.