zdcthomas / quartz_flake

Quartz flake

Usage

With nix installed, and flakes enabled. From inside inside your directory with ./content:

nix flake init -t github:zdcthomas/quartz_flake
nix build

What is this?

The purpose of this flake system is to make it easier to build a static site with the Quartz Static Site generator. This way, builds can be reproducible against either the master version of Quartz, or against a public fork you maintain yourself. This means that your content can be completely seperate from your quartz implementation, which means your content repo can be private, while your fork of Quartz is public.

      ┌────────────────┐ EITHER ┌────────────────┐
      │jackyzha0/quartz│───OR───│your_fork/quartz│
      └────────────────┘   │    └────────────────┘
                           │
                   ┌───────┘
                   │
                   │
                   │ ┌─────────────────┐
                   │ │ Content Repo    │
                   │ │                 │
                   └─┼──►Flake.nix─────┼──►./public─►Deployment
                     │    ▲            │
                     │    └───./content│
                     └─────────────────┘

Important

Right now, it's not super easy to use this to serve your site locally. But I have plans to add that.

Github Actions

Here's an example github action to get it deployed super easily

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: cachix/install-nix-action@v22
        with:
          github_access_token: ${{ secrets.GITHUB_TOKEN }}
      - name: Build release
        run: nix build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./result/public

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1