{"id":16581738,"url":"https://github.com/kaushalmodi/noxhugo","last_synced_at":"2026-04-10T11:01:46.503Z","repository":{"id":77542011,"uuid":"137433136","full_name":"kaushalmodi/noxhugo","owner":"kaushalmodi","description":"Utility to build Hugo sites using ox-hugo (Emacs + Org mode)","archived":false,"fork":false,"pushed_at":"2019-07-16T16:28:20.000Z","size":14,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-12-08T17:53:44.872Z","etag":null,"topics":["cli","emacs","git","hugo","nim","org-mode"],"latest_commit_sha":null,"homepage":null,"language":"Nim","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/kaushalmodi.png","metadata":{"files":{"readme":"README.org","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-06-15T02:45:09.000Z","updated_at":"2021-01-26T22:22:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"d08a65ee-554f-4db4-9ee5-d7f8f19784b6","html_url":"https://github.com/kaushalmodi/noxhugo","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/kaushalmodi/noxhugo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaushalmodi%2Fnoxhugo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaushalmodi%2Fnoxhugo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaushalmodi%2Fnoxhugo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaushalmodi%2Fnoxhugo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaushalmodi","download_url":"https://codeload.github.com/kaushalmodi/noxhugo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaushalmodi%2Fnoxhugo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31639524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cli","emacs","git","hugo","nim","org-mode"],"created_at":"2024-10-11T22:29:47.264Z","updated_at":"2026-04-10T11:01:46.494Z","avatar_url":"https://github.com/kaushalmodi.png","language":"Nim","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+title: noxhugo\n#+author: Kaushal Modi\n\nUtility for generating Hugo sites using ox-hugo (Emacs + Org mode).\n\n-----\n*!ALERT! This project is in very Alpha stage. Feel free to\n  read/review/comment on the Nim code.*\n\nIgnore this alert.. just try out Nim! :)\n-----\n\n* What?\n- [[https://gohugo.io][What is Hugo?]]\n- [[https://ox-hugo.scripter.co/][What is ~ox-hugo~?]]\n* Noxhugo Sub-commands\n~noxhugo~ has the following sub-commands:\n- ~init~\n- ~help~\n** ~noxhugo init~\n\nThis command should be used only for the *first time init* of a site.\n\n1. Checks if ~hugo~ and ~git~ binaries are present in the ~PATH~.\n2. Checks if the ~hugo~ version is \"new enough\".\n   - If it's not new enough, the error thrown will be helpful.\n3. Runs ~hugo new site SITENAME~.\n   - The SITENAME is provided by the user using the \"-d\" switch.\n4. Deletes ~archetypes~ directory from the site as it's useless in the\n   ~ox-hugo~ flow.\n5. Clones the following theme and theme component repos:\n   - Main theme -- https://github.com/kaushalmodi/hugo-bare-min-theme\n   - Theme component -- https://github.com/kaushalmodi/hugo-search-fuse-js\n   - Theme component -- https://github.com/kaushalmodi/hugo-debugprint\n\n   You are free to change these themes later.\n6. Updates the site config with some sane defaults, setting the theme\n   to ~hugo-bare-min-theme~, etc.\n7. Generates a \"starter\" ~site.org~ Org content file.\n8. Git commits all of the above as the first commit.\n\nAfter that command, you can open that ~site.org~ file in Emacs and\n(assuming that you already have the ~ox-hugo~ package installed and\nset up) export it using ~C-c C-e H A~. That will export posts from all\nsubtrees in that file to the ~content/~ directory.\n*** Command\n#+begin_example\nnoxhugo init -d foo\n#+end_example\n\nIf the directory name specified with the \"-d\" switch already exists,\n~hugo~ will not generate a new site.\n\nIn that case, you have a brute-force option -- to delete an existing\nsite if any and create a new one from scratch.\n\n*WARNING! You will lose all content in that directory! It is deleted\n entirely including its git history!*\n\nWith that, here's how you would force-delete an existing site to\ncreate a new one in its place:\n#+begin_example\nnoxhugo init -d foo -F\n#+end_example\n* Help\nShow help for all sub-commands:\n#+begin_example\nnoxhugo help\n#+end_example\n\nShow help only for a given sub-command {X}:\n#+begin_example\nnoxhugo {X} -h\n#+end_example\n* TODO [0/1]\n- [ ] Add ~noxhugo gen~ command so that site is generated using emacs\n  batch mode.\n  - Useful for site generation on CI/CD so that user needss to commit\n    just the Org files.\n  - Useful for non-Emacs users who just like Org mode.\n* Development\n** Dependency for building\n~nim~ built from [[https://github.com/nim-lang/Nim/tree/devel][~devel~ branch]].\n** Building\n[[https://github.com/nim-lang/nimble][~nimble~]] is used to build this project. This utility ships with Nim\ninstallation. Think of it as the equivalent of ~pip~ in Python.\n\nWith Nim/~nimble~ installed, do:\n#+begin_example\ngit clone https://github.com/kaushalmodi/noxhugo\ncd noxhugo\nnimble build # creates the noxhugo binary in the git repo root dir\n#+end_example\n** Installing\nIf you want to install it (will build the binary and copy it to\n=~/.nimble/bin/=), do:\n#+begin_example\n# cd to the git repo dir\nnimble install\n#+end_example\n\n/You need to have added =~/.nimble/bin/= to your ~PATH~ environment\nvariable.\n\n* COMMENT Local Variables                                           :ARCHIVE:\n# Local Variables:\n# fill-column: 70\n# eval: (auto-fill-mode 1)\n# End:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaushalmodi%2Fnoxhugo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaushalmodi%2Fnoxhugo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaushalmodi%2Fnoxhugo/lists"}