{"id":21204960,"url":"https://github.com/codgician/codgician.github.io","last_synced_at":"2025-03-14T22:47:15.545Z","repository":{"id":263113086,"uuid":"889385840","full_name":"codgician/codgician.github.io","owner":"codgician","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-07T15:28:54.000Z","size":368,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T15:25:03.109Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codgician.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"rpearce"}},"created_at":"2024-11-16T08:36:39.000Z","updated_at":"2024-12-07T15:28:58.000Z","dependencies_parsed_at":"2025-01-21T15:33:54.937Z","dependency_job_id":null,"html_url":"https://github.com/codgician/codgician.github.io","commit_stats":null,"previous_names":["codgician/codgician.github.io"],"tags_count":0,"template":false,"template_full_name":"rpearce/hakyll-nix-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codgician%2Fcodgician.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codgician%2Fcodgician.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codgician%2Fcodgician.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codgician%2Fcodgician.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codgician","download_url":"https://codeload.github.com/codgician/codgician.github.io/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243658186,"owners_count":20326465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T20:42:16.644Z","updated_at":"2025-03-14T22:47:15.520Z","avatar_url":"https://github.com/codgician.png","language":"Haskell","funding_links":["https://github.com/sponsors/rpearce"],"categories":[],"sub_categories":[],"readme":"# hakyll-nix-template\n\n[Hakyll](https://jaspervdj.be/hakyll/) + [Nix](https://nixos.org) template\n\n## Quick tips\n\n* Read the tutorial to get started! https://robertwpearce.com/the-hakyll-nix-template-tutorial.html\n* If you make changes to anything inside of `ssg/`, you'll need to clean the\n  hakyll cache and rebuild. This is the preferred series of commands for\n  rebuilding (with logs), cleaning the cache, and re-running the dev server:\n  \n  ```default\n  nix build --print-build-logs \u0026\u0026 \\\n    nix run . clean \u0026\u0026 \\\n    nix run . watch\n  ```\n\n## Features\n\n* Build your site into the `./result/dist` folder:\n  ```\n  λ nix build\n  ```\n* Start hakyll's dev server that reloads when changes are made:\n  ```\n  λ nix run . watch\n  Listening on http://127.0.0.1:8000\n  ...more logs\n  ```\n* Run any hakyll command through `nix run .`!\n  ```\n  λ nix run . clean\n  Removing dist...\n  Removing ssg/_cache...\n  Removing ssg/_tmp...\n  ```\n* Start a development environment that\n  * has your shell environment\n  * has `hakyll-site` (for building/watching/cleaning hakyll projects)\n  * has `hakyll-init` (for generating new projects)\n  * can have anything else you put in the `shell.buildInputs` of the\n    `hakyllProject` in `flake.nix`\n  * is set up to run `ghci` with some defaults and the modules loaded so you can\n    make your own changes and test them out in the ghci REPL\n\n  ```\n  λ nix develop\n\n  [hakyll-nix]λ hakyll-site build\n  ...\n  Success\n\n  [hakyll-nix]λ ghci\n  ...\n  [1 of 1] Compiling Main    ( ssg/src/Main.hs, interpreted )\n  ...\n\n  λ \u003e\n  ```\n\n### hakyll\n\nAll of this is custmomizable, and here are some things that are already done for\nyou:\n\n* [pandoc](https://github.com/jgm/pandoc/) markdown customization to make it as\n  close to GitHub's markdown style as possible\n* [`slugger`](https://hackage.haskell.org/package/slugger) module is included that makes nice link URIs based on post titles\n* RSS \u0026 Atom XML feed generation\n* Sitemap generation\n* Code syntax highlighting customization\n* ...other reasonable defaults\n\nConfigure the dev server, cache \u0026 tmp directories, and more in\n`./ssg/src/Main.hs`.\n\n### Deployment\n\nDeployment is set up through a [GitHub\nAction](https://github.com/features/actions) with [cachix](https://cachix.org),\nand it deploys to a [GitHub Pages](https://pages.github.com/) branch,\n`gh-pages`, when you merge code into your main branch.\n\nSetup information can be found below in the \"Cachix\" section.\n\nNote: If your main branch's name isn't `main`, ensure `'refs/heads/main'` gets\nupdated to `'refs/heads/my-main-branch'` in `./github/workflows/main.yml`.\n\n## Setup\n\n### Nix \u0026 Flakes\n\nIf you don't have [nix](https://nixos.org), follow [the nix installation\ninstructions](https://nixos.org/download.html).\n\nOnce you have nix installed, follow the instructions here to get access to\nflakes: https://nixos.wiki/wiki/Flakes.\n\n### Cachix\n\nThe `./.github/workflows/main.yml` file builds with help from\n[cachix](https://app.cachix.org), so you'll need to generate a signing key to be\nable to do this.\n\n1. Create a cache on cachix for your project\n1. Follow cachix's instructions to generate a signing keypair\n1. Copy the signing keypair value to a new `CACHIX_SIGNING_KEY` secret on\n   https://github.com/settings/secrets\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodgician%2Fcodgician.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodgician%2Fcodgician.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodgician%2Fcodgician.github.io/lists"}