{"id":50571814,"url":"https://github.com/brege/ghrm-hugo","last_synced_at":"2026-06-04T19:01:50.724Z","repository":{"id":350144585,"uuid":"1195933805","full_name":"brege/ghrm-hugo","owner":"brege","description":"A NeoVim plugin and Hugo server for previewing GitHub-flavored README's in a browser","archived":false,"fork":false,"pushed_at":"2026-04-20T00:27:40.000Z","size":113,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-21T07:23:45.558Z","etag":null,"topics":["github-flavored-markdown","github-readme","hugo","lua","markdown","neovim","nvim","readme","theme"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brege.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2026-03-30T07:55:04.000Z","updated_at":"2026-04-20T00:27:44.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/brege/ghrm-hugo","commit_stats":null,"previous_names":["brege/ghrm"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/brege/ghrm-hugo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Fghrm-hugo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Fghrm-hugo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Fghrm-hugo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Fghrm-hugo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brege","download_url":"https://codeload.github.com/brege/ghrm-hugo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Fghrm-hugo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33916321,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-04T02:00:06.755Z","response_time":64,"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":["github-flavored-markdown","github-readme","hugo","lua","markdown","neovim","nvim","readme","theme"],"created_at":"2026-06-04T19:01:50.050Z","updated_at":"2026-06-04T19:01:50.712Z","avatar_url":"https://github.com/brege.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ghrm\n\n\u003e [!IMPORTANT] \n\u003e This project has been superseded by [brege/ghrm](https://github.com/brege/ghrm), based on Rust.\n\u003e This implementation, which is based on Hugo with Python wrappers, has reached its architectural limit.\n\nPreview GitHub-flavored Markdown locally using Hugo. Renders admonitions, Mermaid diagrams, KaTeX math, GeoJSON/TopoJSON maps, and light/dark theme toggling all whilst matching GitHub's README style.\n\n## Ethos\n\nPeople who lose internet and power often: this tool is for you. It renders Markdown the exact same way as GitHub would. If you are offline and still need to make meaningful contributions, focusing on documentation is often the cromulent choice (no coding agents, no Wikipedia/GitHub available, etc).\n\nThe point of this tool is **offline preview**. Install once, then keep working with no network connection when power, internet, or both are unreliable.\n\n## Requirements\n\n- [Hugo](https://gohugo.io/) \u003e= 0.132\n- [uv](https://docs.astral.sh/uv/)\n\n## Install\n\n```bash\ngit clone https://github.com/brege/ghrm.git\ncd ghrm\nmake install\n```\n\n## Usage\n\n```bash\n# one file\nghrm README.md\n\n# multiple files, recursively\nghrm .\n```\n\nOpens a live-reloading preview in your browser. Edits to the file are reflected automatically.\n\n## Neovim\n\nAdd to your lazy.nvim config:\n\n```lua\n{ \"brege/ghrm\", ft = \"markdown\", config = function() require(\"ghrm\").setup() end }\n```\n\nCommands: `:Ghrm` to start, `:GhrmStop` to stop, or just exit nvim.\n\n## Supported Features\n\n- **Works offline**\n- GitHub alert admonitions (`[!NOTE]`, `[!TIP]`, `[!WARNING]`, etc.)\n- Collapsible `\u003cdetails\u003e` sections and normal Markdown formatting and highlighting\n- Mermaid diagrams\n- KaTeX math (inline, display, and fenced `math` blocks)\n- GeoJSON and TopoJSON maps\n- Light/dark theme toggle\n\n### Examples\n\n- [Basics](test/basics.md)\n- [Diagrams](test/diagrams.md)\n\n```bash\nghrm README.md\nghrm test/basics.md\nghrm test/diagrams.md\nghrm .\n```\n\n## Uninstall\n\n```bash\nmake uninstall\nmake clean\n```\n\n## License\n\n[GPL-3.0](LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrege%2Fghrm-hugo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrege%2Fghrm-hugo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrege%2Fghrm-hugo/lists"}