commit 6b1d9846e9c20c0285a79d1e4d59e2d4427ca677 · pyrox.dev/nixpkgs

doc/languages-frameworks/index.md

···

       96
       96
        
       swift.section.md

     

       97
       97
        
       tcl.section.md

     

       98
       98
        
       texlive.section.md

     

       99
       99
       +
       typst.section.md

     

       99
       100
        
       vim.section.md

     

       100
       101
        
       neovim.section.md

     

       101
       102
        
       ```

+62

doc/languages-frameworks/typst.section.md

···

       1
       1
       +
       # Typst {#typst}

     

       2
       2
       +
       

     

       3
       3
       +
       Typst can be configured to include packages from [Typst Universe](https://typst.app/universe/) or custom packages.

     

       4
       4
       +
       

     

       5
       5
       +
       ## Custom Environment {#typst-custom-environment}

     

       6
       6
       +
       

     

       7
       7
       +
       You can create a custom Typst environment with a selected set of packages from **Typst Universe** using the following code. It is also possible to specify a Typst package with a specific version (e.g., `cetz_0_3_0`). A package without a version number will always refer to its latest version.

     

       8
       8
       +
       

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       typst.withPackages (p: with p; [

     

       11
       11
       +
         polylux_0_4_0

     

       12
       12
       +
         cetz_0_3_0

     

       13
       13
       +
       ])

     

       14
       14
       +
       ```

     

       15
       15
       +
       

     

       16
       16
       +
       ### Handling Outdated Package Hashes {#typst-handling-outdated-package-hashes}

     

       17
       17
       +
       

     

       18
       18
       +
       Since **Typst Universe** does not provide a way to fetch a package with a specific hash, the package hashes in `nixpkgs` can sometimes be outdated. To resolve this issue, you can manually override the package source using the following approach:

     

       19
       19
       +
       

     

       20
       20
       +
       ```nix

     

       21
       21
       +
       typst.withPackages.override (old: {

     

       22
       22
       +
         typstPackages = old.typstPackages.extend (_: previous: {

     

       23
       23
       +
           polylux_0_4_0 = previous.polylux_0_4_0.overrideAttrs (oldPolylux: {

     

       24
       24
       +
             src = oldPolylux.src.overrideAttrs {

     

       25
       25
       +
               outputHash = YourUpToDatePolyluxHash;

     

       26
       26
       +
             };

     

       27
       27
       +
           });

     

       28
       28
       +
         });

     

       29
       29
       +
       }) (p: with p; [

     

       30
       30
       +
         polylux_0_4_0

     

       31
       31
       +
         cetz_0_3_0

     

       32
       32
       +
       ])

     

       33
       33
       +
       ```

     

       34
       34
       +
       

     

       35
       35
       +
       ## Custom Packages {#typst-custom-packages}

     

       36
       36
       +
       

     

       37
       37
       +
       `Nixpkgs` provides a helper function, `buildTypstPackage`, to build custom Typst packages that can be used within the Typst environment. However, all dependencies of the custom package must be explicitly specified in `typstDeps`.

     

       38
       38
       +
       

     

       39
       39
       +
       Here's how to define a custom Typst package:

     

       40
       40
       +
       

     

       41
       41
       +
       ```nix

     

       42
       42
       +
       { buildTypstPackage, typstPackages, fetchzip }:

     

       43
       43
       +
       

     

       44
       44
       +
       buildTypstPackage (finalAttrs: {

     

       45
       45
       +
         pname = "my-typst-package";

     

       46
       46
       +
         version = "0.0.1";

     

       47
       47
       +
         src = fetchzip { ... };

     

       48
       48
       +
         typstDeps = with typstPackages; [ cetz_0_3_0 ];

     

       49
       49
       +
       })

     

       50
       50
       +
       ```

     

       51
       51
       +
       

     

       52
       52
       +
       ### Package Scope and Usage {#typst-package-scope-and-usage}

     

       53
       53
       +
       

     

       54
       54
       +
       By default, every custom package is scoped under `@preview`, as shown below:

     

       55
       55
       +
       

     

       56
       56
       +
       ```typst

     

       57
       57
       +
       #import "@preview/my-typst-package:0.0.1": *

     

       58
       58
       +
       ```

     

       59
       59
       +
       

     

       60
       60
       +
       Since `@preview` is intended for packages from **Typst Universe**, it is recommended to use this approach **only for temporary or experimental modifications over existing packages** from **Typst Universe**.

     

       61
       61
       +
       

     

       62
       62
       +
       On the other hand, **local packages**, packages scoped under `@local`, are **not** considered part of the Typst environment. This means that local packages must be manually linked to the Typst compiler if needed.

+18

doc/redirects.json

···

       368
       368
        
         "tester-testEqualArrayOrMap-return": [

     

       369
       369
        
           "index.html#tester-testEqualArrayOrMap-return"

     

       370
       370
        
         ],

     

       371
       371
       +
         "typst": [

     

       372
       372
       +
           "index.html#typst",

     

       373
       373
       +
           "doc/languages-frameworks/typst.section.md#typst"

     

       374
       374
       +
         ],

     

       375
       375
       +
         "typst-custom-environment": [

     

       376
       376
       +
           "index.html#typst-custom-environment",

     

       377
       377
       +
           "doc/languages-frameworks/typst.section.md#typst-custom-environment"

     

       378
       378
       +
         ],

     

       379
       379
       +
         "typst-custom-packages": [

     

       380
       380
       +
           "index.html#typst-custom-packages",

     

       381
       381
       +
           "doc/languages-frameworks/typst.section.md#typst-custom-packages"

     

       382
       382
       +
         ],

     

       383
       383
       +
         "typst-handling-outdated-package-hashes": [

     

       384
       384
       +
           "index.html#typst-handling-outdated-package-hashes"

     

       385
       385
       +
         ],

     

       386
       386
       +
         "typst-package-scope-and-usage": [

     

       387
       387
       +
           "index.html#typst-package-scope-and-usage"

     

       388
       388
       +
         ],

     

       371
       389
        
         "variables-specifying-dependencies": [

     

       372
       390
        
           "index.html#variables-specifying-dependencies"

     

       373
       391
        
         ],