Reduce complexity for enduser

.github/workflows/build.yaml

@@ -18,8 +18,9 @@ jobs:
           lfs: true
 
       - uses: typst-community/setup-typst@v3
-      - run: typst compile thesis.typ thesis.pdf
-      - run: typst compile proposal.typ proposal.pdf
+      - run: typst compile ./template/thesis.typ thesis.pdf --root "./"
+      # NOTE: Update proposal.typ and comment out the following line if you want to build the proposal.
+      # - run: typst compile proposal.typ proposal.pdf
 
       - name: Upload Release Asset - Assignment
         id: upload
@@ -35,5 +36,6 @@ jobs:
         uses: thollander/actions-comment-pull-request@v2
         with:
           reactions: eyes, rocket
+          comment_tag: file-upload
           message: |
             Thank you for your contribution. Review ready at: ${{ steps.upload.outputs.artifact-url }}

.github/workflows/release.yaml

@@ -33,8 +33,9 @@ jobs:
           DEFAULT_BUMP: 'patch'
 
       - uses: typst-community/setup-typst@v3
-      - run: typst compile thesis.typ thesis.pdf
-      - run: typst compile proposal.typ proposal.pdf
+      - run: typst compile ./template/thesis.typ thesis.pdf
+      # NOTE: Add back proposal.typ when ready
+      # - run: typst compile proposal.typ proposal.pdf
 
       - name: Create Release
         id: create_release
@@ -44,6 +45,6 @@ jobs:
           name: Version ${{ steps.bump.outputs.new_tag }}
           draft: false
           prerelease: false
+          # NOTE: Add back proposal.pdf when ready
           files: |
             thesis.pdf
-            proposal.pdf

.gitignore

@@ -1,2 +1,3 @@
 .direnv/*
 .pre-commit-config.yaml
+*.pdf

README.md

@@ -7,7 +7,7 @@
   - [x] Back page
   - [x] Supervisors page
   - [ ] List of Definitions
-  - [ ] List of Abbreviations
+  - [x] List of Abbreviations
 - [ ] Styling
   - [ ] Headings (chapter on odd, subsection on even)
   - [ ] Font features
@@ -24,5 +24,5 @@
 - [x] CI/CD
   - [x] Formatting
   - [x] Build and Release pdf
-  - [ ] Release as lib
+  - [/] Release as lib
 - [ ] License

flake.nix

@@ -1,20 +1,32 @@
 {
   inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    nixpkgs = {
+      url = "github:NixOS/nixpkgs/nixos-unstable";
+    };
     flake-utils = {
       url = "github:numtide/flake-utils";
-      inputs.nixpkgs.follows = "nixpkgs";
     };
     pre-commit-hooks = {
       url = "github:cachix/git-hooks.nix";
       inputs.nixpkgs.follows = "nixpkgs";
     };
+    typst-packages = {
+      url = "github:typst/packages";
+      flake = false;
+    };
+    typst-nix = {
+      url = "github:misterio77/typst-nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+      inputs.typst-packages.follows = "typst-packages";
+    };
   };
   outputs =
     { self
     , nixpkgs
     , flake-utils
     , pre-commit-hooks
+    , typst-nix
+    , typst-packages
     , ...
     }:
     flake-utils.lib.eachDefaultSystem (
@@ -33,6 +45,23 @@
           };
         };
 
+        packages = {
+          default = typst-nix.lib.${system}.mkTypstDerivation {
+            name = "nixy-thesis-typst";
+            src = ./.;
+            extraFonts = with pkgs; [
+              noto-fonts
+              open-sans
+              iosevka
+            ];
+            extraCompileFlags = [ "--root" "./" ];
+            mainFile = "template/thesis.typ";
+            typstPackages = {
+              preview = "${typst-packages}/packages/preview";
+            };
+          };
+        };
+
         devShells.default = mkShell {
           inherit (self.checks.${system}.pre-commit-check) shellHook;
 
@@ -48,6 +77,7 @@
             paths = with pkgs; [
               noto-fonts
               open-sans
+              iosevka
             ];
           };
         };