{"id":29866535,"url":"https://github.com/ficd0/helix-pdf","last_synced_at":"2025-07-30T12:39:43.453Z","repository":{"id":291673913,"uuid":"978381275","full_name":"ficd0/helix-pdf","owner":"ficd0","description":"Scripts for working with PDF and previews in Helix","archived":false,"fork":false,"pushed_at":"2025-05-05T23:47:46.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-22T04:35:21.772Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ficd0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"zenodo":null}},"created_at":"2025-05-05T22:39:25.000Z","updated_at":"2025-05-05T23:48:01.000Z","dependencies_parsed_at":"2025-05-06T00:35:39.760Z","dependency_job_id":"4799ec2a-4b14-42cb-a11c-c028f74e5af6","html_url":"https://github.com/ficd0/helix-pdf","commit_stats":null,"previous_names":["ficcdaf/helix-pdf","ficd0/helix-pdf"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ficd0/helix-pdf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fhelix-pdf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fhelix-pdf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fhelix-pdf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fhelix-pdf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ficd0","download_url":"https://codeload.github.com/ficd0/helix-pdf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fhelix-pdf/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267867871,"owners_count":24157369,"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","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-07-30T12:39:41.657Z","updated_at":"2025-07-30T12:39:43.440Z","avatar_url":"https://github.com/ficd0.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Helix PDF\n\nThis repository contains scripts that make working with PDF previews more\nconvenient in Helix. Currently, only the Typst preview is provided.\n\n## Zathura Typst Preview\n\n### Installation\n\n- Download the [hx-typ-zathura.fish](./hx-typ-zathura.fish) file.\n\n### Dependencies\n\n- Helix built from `master`.\n- [fish](https://fishshell.com/)\n  - Needs to be available, but it does _not_ need to be your selected shell.\n- [fd](https://github.com/sharkdp/fd)\n- [typst](https://github.com/typst/typst)\n- [zathura](https://github.com/pwmt/zathura)\n- `git`\n- `waitpid`\n\n### Usage\n\nAssign the command to a keybinding in Helix. Take care to include the\n`%{buffer_name}` command expansion. For example:\n\n```toml\nyour_key = ':sh /path/to/hx-typ-zathura.fish --watch --kill-on-exit %{buffer_name}'\n```\n\nYou can use this script to conveniently open a PDF preview to the Typst document\nyou are currently editing. It will do its best to find the PDF file that matches\nyour current buffer. It will check the current directory first, then it will\nsearch recursively from the repository root. If you're not in a repository,\nit'll recursively search from your working directory, instead.\n\nOptionally, the Zathura window can be killed if you close Helix. There is also\nan option to continuously update the preview using `typst watch`.\n\nIt takes the path to the typst file as its only argument, and the following\noptions are provided:\n\n```\n-q/--quiet: Don't echo back to Helix on caught errors, return 1 instead.\n-k/--kill-on-exit: Kill Zathura and typst when Helix exits.\n-w/--watch: Use typst watch to compile a live preview.\n-h/--help: Print help screen.\n```\n\nTo avoid spawning a large number of `typst watch` processes, the `--watch`\noption _only_ works if `--kill-on-exit` is also set.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fficd0%2Fhelix-pdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fficd0%2Fhelix-pdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fficd0%2Fhelix-pdf/lists"}