alexandria/documents
Youwen Wu 366fefd38a
Some checks failed
Deploy Quartz site to GitHub Pages using Nix / build (push) Has been cancelled
Deploy Quartz site to GitHub Pages using Nix / deploy (push) Has been cancelled
auto-update(nvim): 2025-01-09 00:49:32
2025-01-09 00:49:33 -08:00
..
by-course auto-update(nvim): 2025-01-09 00:49:32 2025-01-09 00:49:33 -08:00
by-name refactor: massive reorganization 2024-12-29 02:01:18 -08:00
nix fix: pass the flakeSelf argument to typst packages 2025-01-06 15:51:19 -08:00
flake.lock documents/flake.lock: Update 2025-01-06 15:40:16 -08:00
flake.nix feat: add flakeSelf and package.nix for course notes 2025-01-06 15:44:51 -08:00
README.md refactor: massive reorganization 2024-12-29 02:01:18 -08:00

alexandria, the document repository

This is where documents and their derivations are stored. The source code of the document and its corresponding package.nix are placed in the same place.

There are two ways to organize documents. You can directly place the document in by-name, suitable for documents not assorted with a particular course and various miscellany.

For documents related to specific courses, it is preferable to create a directory for that course in by-course, and then nesting the document directory within the course directory. This will create a nested structure for the packages as well.

For example, the following path:

by-name/my-document

will result in a package set containing my-document.

The path

by-course/phil-1/paper-1

results in a nested package set containing phil-1.paper-1. That means that you can build that document with the command

nix build .#phil-1.paper-1

It's evident that this organization structure could be useful for organizing by some topics other than courses, so the naming may change in the future.