{"id":34842645,"url":"https://github.com/chrishrb/go-grip","last_synced_at":"2025-12-25T17:16:10.571Z","repository":{"id":257821421,"uuid":"870353702","full_name":"chrishrb/go-grip","owner":"chrishrb","description":"Preview Markdown files locally before committing them.","archived":false,"fork":false,"pushed_at":"2025-07-30T13:09:56.000Z","size":1337,"stargazers_count":74,"open_issues_count":8,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-30T15:57:31.537Z","etag":null,"topics":["cli","github","go","grip","html","markdown","markdown-preview","readme"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/chrishrb.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":"2024-10-09T22:16:20.000Z","updated_at":"2025-07-30T13:10:00.000Z","dependencies_parsed_at":"2024-12-09T09:21:42.428Z","dependency_job_id":"407577c6-20c5-4fb6-860e-26dcf0e96c19","html_url":"https://github.com/chrishrb/go-grip","commit_stats":null,"previous_names":["chrishrb/go-grip"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/chrishrb/go-grip","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrishrb%2Fgo-grip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrishrb%2Fgo-grip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrishrb%2Fgo-grip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrishrb%2Fgo-grip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrishrb","download_url":"https://codeload.github.com/chrishrb/go-grip/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrishrb%2Fgo-grip/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28033469,"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-12-25T02:00:05.988Z","response_time":58,"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":["cli","github","go","grip","html","markdown","markdown-preview","readme"],"created_at":"2025-12-25T17:16:08.861Z","updated_at":"2025-12-25T17:16:10.562Z","avatar_url":"https://github.com/chrishrb.png","language":"CSS","readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"#\"\u003e\n    \u003cimg src=\".github/docs/logo-1.png\" alt=\"Logo\" height=\"120\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003ego-grip\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Render your markdown files local\u003cbr\u003e- with the look of GitHub\n  \u003c/p\u003e\n\u003c/div\u003e\n\n## :question: About\n\n**go-grip** is a lightweight, Go-based tool designed to render Markdown files locally, replicating GitHub's style. It offers features like syntax highlighting, dark mode, and support for mermaid diagrams, providing a seamless and visually consistent way to preview Markdown files in your browser.\n\nThis project is a reimplementation of the original Python-based [grip](https://github.com/joeyespo/grip), which uses GitHub's web API for rendering. By eliminating the reliance on external APIs, go-grip delivers similar functionality while being fully self-contained, faster, and more secure - perfect for offline use or privacy-conscious users.\n\n## :zap: Features\n\n- :zap: Written in Go :+1:\n- 📄 Render markdown to HTML and view it in your browser\n- 📱 Dark and light theme\n- 🎨 Syntax highlighting for code\n- [x] Todo list like the one on GitHub\n- Support for github markdown emojis :+1: :bowtie:\n- Support for mermaid diagrams\n\n```mermaid\ngraph TD;\n      A--\u003eB;\n      A--\u003eC;\n      B--\u003eD;\n      C--\u003eD;\n```\n\n\u003e [!TIP]\n\u003e Support of blockquotes (note, tip, important, warning and caution) [see here](https://github.com/orgs/community/discussions/16925)\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e test\n\n## :rocket: Getting started\n\nTo install go-grip, simply:\n\n```bash\ngo install github.com/chrishrb/go-grip@latest\n```\n\n\u003e [!TIP]\n\u003e You can also use nix flakes to install this plugin.\n\u003e More useful information [here](https://nixos.wiki/wiki/Flakes).\n\n## :hammer: Usage\n\nTo render the `README.md` file simply execute:\n\n```bash\ngo-grip README.md\n# or\ngo-grip\n```\n\nThe browser will automatically open on http://localhost:6419. You can disable this behaviour with the `-b=false` option.\n\nYou can also specify a port:\n\n```bash\ngo-grip -p 80 README.md\n```\n\nor just open a file-tree with all available files in the current directory:\n\n```bash\ngo-grip -r=false\n```\n\nIt's also possible to activate the darkmode:\n\n```bash\ngo-grip -d .\n```\n\nTo terminate the current server simply press `CTRL-C`.\n\n## :pencil: Examples\n\n\u003cimg src=\"./.github/docs/example-1.png\" alt=\"examples\" width=\"1000\"/\u003e\n\n## :bug: Known TODOs / Bugs\n\n- [ ] Tests and refactoring\n- [ ] Make it possible to export the generated html\n\n## :pushpin: Similar tools\n\nThis tool is a Go-based reimplementation of the original [grip](https://github.com/joeyespo/grip), offering the same functionality without relying on GitHub's web API.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrishrb%2Fgo-grip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrishrb%2Fgo-grip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrishrb%2Fgo-grip/lists"}