{"id":13442339,"url":"https://github.com/teesloane/firn","last_synced_at":"2025-04-06T20:12:28.974Z","repository":{"id":38222533,"uuid":"244232874","full_name":"teesloane/firn","owner":"teesloane","description":"Org Mode Static Site Generator","archived":false,"fork":false,"pushed_at":"2022-08-02T12:46:07.000Z","size":52182,"stargazers_count":323,"open_issues_count":5,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-02T01:52:52.730Z","etag":null,"topics":["emacs","org-mode","rust","static-site-generator"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teesloane.png","metadata":{"files":{"readme":"README.org","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-01T22:20:51.000Z","updated_at":"2024-04-26T11:06:42.000Z","dependencies_parsed_at":"2022-08-09T00:16:10.153Z","dependency_job_id":null,"html_url":"https://github.com/teesloane/firn","commit_stats":null,"previous_names":["teesloane/firn","theiceshelf/firn"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teesloane%2Ffirn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teesloane%2Ffirn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teesloane%2Ffirn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teesloane%2Ffirn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teesloane","download_url":"https://codeload.github.com/teesloane/firn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299766,"owners_count":20916183,"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":["emacs","org-mode","rust","static-site-generator"],"created_at":"2024-07-31T03:01:44.515Z","updated_at":"2025-04-06T20:12:28.946Z","avatar_url":"https://github.com/teesloane.png","language":"Rust","funding_links":["https://github.com/sponsors/teesloane"],"categories":["Clojure","Rust"],"sub_categories":[],"readme":"#+html: \u003ch2 align=\"center\"\u003eFirn\u003c/h2\u003e\n#+html: \u003cp align=\"center\"\u003eA Static Site Generator for Org Mode\u003c/p\u003e\n#+html: \u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/theiceshelf/firn/releases\"\u003e\u003cimg alt=\"GitHub release (latest by date including pre-releases)\" src=\"https://img.shields.io/github/v/release/theiceshelf/firn?color=%2316a085\u0026include_prereleases\u0026style=flat-square\"\u003e\u003ca/\u003e\u0026nbsp;\u003cimg src=\"https://img.shields.io/badge/Status-Alpha-%23f39c12?style=flat-square\"\u003e\u0026nbsp;\u003ca href=\"https://discord.gg/TbgKxYb\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/707754224871669770?color=%233498db\u0026label=Discord%20Chat%20\u0026style=flat-square\"\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://github.com/sponsors/teesloane\"\u003e\u003cimg src=\"https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\n* What's Firn?\nFirn generates a static site from org-mode files. It is a bit different from other static site generators, in that it intends to be a drop in solution for creating sites from already existing folders of org-files. Further, because org-mode has great capacity for collecting and displaying different kinds of data (links, logbooks, drawers, task keywords, tags, etc) we can make this data available when org-content is parsed into a data structure.\n\nCurrently, running the firn binary on a directory of org files performs the following:\n\n- Reads all .org files in the directory recursively.\n- Parses org-files into data structures with the lovely [[https://github.com/PoiScript/orgize][Orgize]].\n- Collects all file links, tags and logbooks across all files.\n- Passes files through a template system called [[https://github.com/Keats/tera][Tera]], and renders to HTML.\n\n* How do I use it?\n\n- Download the latest binary from the Github Releases page.\n- Add the binary to your path, or use the =-d= flag to pass a directory to Firn\n\n#+begin_src\n\n# navigate to a directory that has some org-files in it, then\n# scaffold out a site:\nfirn new\n\n# go explore what was generated:\nls -la _firn\n\n# start a server and go looking for your files:\n# if you have an org file called 'foo.org' it will become 'foo.html' etc.\nfirn serve\n\n# ready to build the output?\nfirn build\n#+end_src\n\n\nRead the full usage documentation [[https://theiceshelf.com/firn.html][here]].\n\n* Development \u0026 Contributing\n\n- Rust version =1.58.0=\n- see =Makefile= commands.\n- You'll need a folder of Org files to test on.\n\nA small roadmap can be found [[https://theiceshelf.com/firn.html#Roadmap][here.]]\n\n* Limitations\n** Development Server\n\nThe development server is quite naive. There is no caching or diffing in the replacement of changed assets in the /static or /data folder.\n** Footnotes\nDue to how the parser parses footnotes, they must look like so:\n#+begin_src\n[fn:1]\n\n\u003cMy footnote\u003e\n#+end_src\n\n*Not* like this:\n\n#+begin_src\n\n[fn:1] \u003cMy Footnote\u003e\n\n#+end_src\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteesloane%2Ffirn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteesloane%2Ffirn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteesloane%2Ffirn/lists"}