➕ Add font-awesome

Author: Freed-Wu

.github/workflows/main.yml

@@ -16,6 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: typst-community/setup-typst@v3
       - uses: actions/checkout@v4
         with:
           repository: chengda/popular-fonts
@@ -24,15 +25,24 @@ jobs:
         with:
           repository: StellarCN/scp_zh
           path: fonts/scp_zh
-      - uses: typst-community/setup-typst@v3
+      - uses: actions/checkout@v4
+        with:
+          repository: siaimes/pytorch
+          path: fonts/pytorch
+      - uses: actions/checkout@v4
+        with:
+          repository: Kangzhengwei/androidFront
+          path: fonts/androidFront
       - run: |
+          sudo apt-get -y update
+          sudo apt-get -y install fonts-font-awesome
           mkdir -p ~/.local/share
           mv fonts ~/.local/share
-          typst compile main.typ
+          typst compile template/main.typ
       - uses: actions/upload-artifact@v4
         with:
           path: ./*.pdf
       - uses: softprops/action-gh-release@v2
         if: github.ref_type == 'tag'
         with:
-          files: main.pdf
+          files: template/main.pdf

.pre-commit-config.yaml

@@ -72,6 +72,10 @@ repos:
       - id: markdownlint-cli2
         additional_dependencies:
           - markdown-it-texmath
+  - repo: https://github.com/Enter-tainer/typstyle
+    rev: v0.12.14
+    hooks:
+      - id: typstyle
   - repo: https://github.com/NixOS/nixfmt
     rev: 8d4bd690c247004d90d8554f0b746b1231fe2436
     hooks:

README.md

@@ -1,4 +1,4 @@
-# USTC proposal template
+# USTC proposal
 
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ustc-ivclab/ustc-proposal/main.svg)](https://results.pre-commit.ci/latest/github/ustc-ivclab/ustc-proposal/main)
 [![github/workflow](https://github.com/ustc-ivclab/ustc-proposal/actions/workflows/main.yml/badge.svg)](https://github.com/ustc-ivclab/ustc-proposal/actions)
@@ -27,13 +27,33 @@
 [![github/repo-size](https://shields.io/github/repo-size/ustc-ivclab/ustc-proposal)](https://github.com/ustc-ivclab/ustc-proposal)
 [![github/v](https://shields.io/github/v/release/ustc-ivclab/ustc-proposal)](https://github.com/ustc-ivclab/ustc-proposal)
 
+![screenshot](template/images/main-1.png)
+
 ## Dependencies
 
 - [华文字体](https://github.com/chengda/popular-fonts)
 - [中易字体](https://github.com/StellarCN/scp_zh/tree/master/fonts)
+- [方正字体](https://github.com/Kangzhengwei/androidFront)
+- [Times New Roman](https://github.com/siaimes/pytorch/tree/main/fonts)
+- [font-awesome](https://github.com/FortAwesome/Font-Awesome)
 
 ## Build
 
+Download all fonts, then
+
 ```sh
 typst compile main.typ
 ```
+
+Or use Nix:
+
+```sh
+nix run '.#build'
+```
+
+## Related Projects
+
+### USTC proposal template
+
+- [docx](https://cicpi.ustc.edu.cn/indico/conferenceDisplay.py?confId=971)
+- [LaTeX](https://github.com/cgdsss/thesis_proposal_ustc)

flake.lock

@@ -0,0 +1,143 @@
+{
+  description = "ustc-proposal";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+
+    typix = {
+      url = "github:loqusion/typix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+
+    flake-utils.url = "github:numtide/flake-utils";
+
+    typst-packages = {
+      url = "github:typst/packages";
+      flake = false;
+    };
+
+    fonts-popular-fonts = {
+      url = "github:chengda/popular-fonts";
+      flake = false;
+    };
+
+    fonts-scp_zh = {
+      url = "github:StellarCN/scp_zh";
+      flake = false;
+    };
+
+    fonts-pytorch = {
+      url = "github:siaimes/pytorch";
+      flake = false;
+    };
+
+    fonts-androidFront = {
+      url = "github:Kangzhengwei/androidFront";
+      flake = false;
+    };
+  };
+
+  outputs =
+    inputs@{
+      nixpkgs,
+      typix,
+      flake-utils,
+      ...
+    }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+        typixLib = typix.lib.${system};
+
+        src = typixLib.cleanTypstSource ./.;
+        commonArgs = {
+          typstSource = "template/main.typ";
+
+          fontPaths = [
+            "${pkgs.font-awesome}/share/fonts/opentype"
+            "${inputs.fonts-popular-fonts}"
+            "${inputs.fonts-scp_zh}/fonts"
+            "${inputs.fonts-pytorch}/fonts"
+            "${inputs.fonts-androidFront}"
+          ];
+
+          virtualPaths = [
+            # Add paths that must be locally accessible to typst here
+            # {
+            #   dest = "icons";
+            #   src = "${inputs.font-awesome}/svgs/regular";
+            # }
+          ];
+        };
+        typstPackagesSrc = pkgs.symlinkJoin {
+          name = "typst-packages-src";
+          paths = [
+            "${inputs.typst-packages}/packages"
+            # More Typst packages can be added here
+          ];
+        };
+        typstPackagesCache = pkgs.stdenvNoCC.mkDerivation {
+          name = "typst-packages-cache";
+          src = typstPackagesSrc;
+          dontBuild = true;
+          installPhase = ''
+            mkdir -p "$out/typst/packages"
+            cp -LR --reflink=auto --no-preserve=mode -t "$out/typst/packages" "$src"/*
+          '';
+        };
+
+        # Compile a Typst project, *without* copying the result
+        # to the current directory
+        build-drv = typixLib.buildTypstProject (
+          commonArgs
+          // {
+            inherit src;
+            XDG_CACHE_HOME = typstPackagesCache;
+          }
+        );
+
+        # Compile a Typst project, and then copy the result
+        # to the current directory
+        build-script = typixLib.buildTypstProjectLocal (
+          commonArgs
+          // {
+            inherit src;
+            XDG_CACHE_HOME = typstPackagesCache;
+          }
+        );
+
+        # Watch a project and recompile on changes
+        watch-script = typixLib.watchTypstProject commonArgs;
+      in
+      {
+        checks = {
+          inherit build-drv build-script watch-script;
+        };
+
+        packages.default = build-drv;
+
+        apps = rec {
+          default = watch;
+          build = flake-utils.lib.mkApp {
+            drv = build-script;
+          };
+          watch = flake-utils.lib.mkApp {
+            drv = watch-script;
+          };
+        };
+
+        devShells.default = typixLib.devShell {
+          inherit (commonArgs) fontPaths virtualPaths;
+          packages = [
+            # WARNING: Don't run `typst-build` directly, instead use `nix run .#build`
+            # See https://github.com/loqusion/typix/issues/2
+            # build-script
+            watch-script
+            # More packages can be added here, like typstfmt
+            # pkgs.typstfmt
+          ];
+        };
+      }
+    );
+}