README-en.md

satyxin

Are you SATySFi-ed with Nix?

• 日本語（おそらくこちらのほうが充実しています）

Example

• basic.pdf
  • Source
• slide.pdf
  • Source
  • Original source is monaqa/slydifi

Usage

This flake is very unstable currently. It may be useful to see also template by author.

Requirements

• Nix (of course)
• Enabling Nix Flakes
• nix-direnv
  • Not required but SHOULD.

Setup

Write flake.nix like below, then nix build ".#main" to build document to result/main.pdf.

{
  inputs = { 
    satyxin.url = "github:SnO2WMaN/satyxin";
  };
  outputs = { 
    satyxin, 
    ...
  } @ inputs:
    flake-utils.lib.eachDefaultSystem (
      system: let
        pkgs = import nixpkgs {
          inherit system;
          overlays = [ 
            satyxin.overlay
          ];
        };
      in rec {
        packages = rec {
          satysfiDist = pkgs.satyxin.buildSatysfiDist {
            # Add pacakges to build your document
            # All available packages https://github.com/SnO2WMaN/satyxin/tree/main/nix/packages
            packages = [
              "bibyfi"
              "sno2wman"
            ];
          };
          main = pkgs.satyxin.buildDocument {
            inherit satysfiDist;
            satysfiLocal = ./.satysfi/local; # optional
            name = "main";
            src = ./src;
            entrypoint = "main.saty";
            output = "main.pdf"; # optional
          };
        }
      }
    );
}

Write .envrc by using direnv.

#!/usr/bin/env bash
use flake

nix build ".#satysfiDist"  --out-link "$(pwd)/.satysfi/dist"

References

• AumyF/satyxin
  • Original version of this attempt.
• na4zagin3/satyrographos
  • Most major SATySFi package manager.