{"id":15034230,"url":"https://github.com/textualize/frogmouth","last_synced_at":"2025-05-14T12:11:57.042Z","repository":{"id":159147518,"uuid":"622876059","full_name":"Textualize/frogmouth","owner":"Textualize","description":"A Markdown browser for your terminal","archived":false,"fork":false,"pushed_at":"2024-08-01T06:51:47.000Z","size":714,"stargazers_count":2763,"open_issues_count":36,"forks_count":54,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-05-08T00:07:00.213Z","etag":null,"topics":["markdown","markdown-viewer","python","terminal-based","textual","tui"],"latest_commit_sha":null,"homepage":"https://www.textualize.io/","language":"Python","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/Textualize.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","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}},"created_at":"2023-04-03T08:41:03.000Z","updated_at":"2025-05-06T19:57:28.000Z","dependencies_parsed_at":"2024-01-07T21:02:35.803Z","dependency_job_id":"d82b9b6f-5b03-4231-bce4-d4613c08bab7","html_url":"https://github.com/Textualize/frogmouth","commit_stats":{"total_commits":400,"total_committers":5,"mean_commits":80.0,"dds":0.08250000000000002,"last_synced_commit":"15c3e85a6e84b2e4a6845723acf12beb54c81eb2"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Textualize%2Ffrogmouth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Textualize%2Ffrogmouth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Textualize%2Ffrogmouth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Textualize%2Ffrogmouth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Textualize","download_url":"https://codeload.github.com/Textualize/frogmouth/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254140768,"owners_count":22021220,"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":["markdown","markdown-viewer","python","terminal-based","textual","tui"],"created_at":"2024-09-24T20:24:19.386Z","updated_at":"2025-05-14T12:11:56.989Z","avatar_url":"https://github.com/Textualize.png","language":"Python","readme":"\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/554369/234892488-856f9da7-7b82-4429-ac35-0d0545bf0d24.png\"  width=\"300\" align=\"center\"/\u003e\n\u003c/p\u003e\n\n[![Discord](https://img.shields.io/discord/1026214085173461072)](https://discord.gg/Enf6Z3qhVr)\n\n\n\n# Frogmouth\n\n\nFrogmouth is a Markdown viewer / browser for your terminal, built with [Textual](https://github.com/Textualize/textual).\n\nFrogmouth can open `*.md` files locally or via a URL.\nThere is a familiar browser-like navigation stack, history, bookmarks, and table of contents.\n\n\u003cdetails\u003e  \n  \u003csummary\u003e 🎬 Demonstration \u003c/summary\u003e\n  \u003chr\u003e\n\nA quick video tour of Frogmouth.\n\n\n\n\nhttps://user-images.githubusercontent.com/554369/235305502-2699a70e-c9a6-495e-990e-67606d84bbfa.mp4\n\n(thanks [Screen Studio](https://www.screen.studio/))\n\n\n\u003c/details\u003e\n\n## Screenshots\n\n\u003ctable\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\n\u003cimg width=\"100%\" align=\"left\" alt=\"Screenshot 2023-04-28 at 15 14 53\" src=\"https://user-images.githubusercontent.com/554369/235172015-555565a0-3df0-4e5d-b621-23e84fec82a3.png\"\u003e\n\u003c/td\u003e\n\n\u003ctd\u003e\n\u003cimg width=\"100%\" align=\"right\" alt=\"Screenshot 2023-04-28 at 15 17 56\" src=\"https://user-images.githubusercontent.com/554369/235172990-54460daf-baf4-4e02-aa22-9cec58d15315.png\"\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\n\u003ctd\u003e\n\u003cimg width=\"100%\" alt=\"Screenshot 2023-04-28 at 15 18 36\" src=\"https://user-images.githubusercontent.com/554369/235173115-012e35fa-d737-4794-a696-0d5cb0b68490.png\"\u003e\n\u003c/td\u003e\n\n\u003ctd\u003e\n\u003cimg width=\"100%\" alt=\"Screenshot 2023-04-28 at 15 16 39\" src=\"https://user-images.githubusercontent.com/554369/235173418-58c23583-3fb3-4ff1-a723-10fa607cdd48.png\"\u003e\n\u003c/td\u003e\n\n\u003c/tr\u003e\n\n\u003c/table\u003e\n\n\n## Compatibility\n\nFrogmouth runs on Linux, macOS, and Windows. Frogmouth requires Python **3.8** or above.\n\n\n## Installing\n\nThe easiest way to install Frogmouth is with [pipx](https://pypa.github.io/pipx/) (particularly if you aren't a Python developer).\n\n```\npipx install frogmouth\n```\n\nYou can also install Frogmouth with `pip`:\n\n```\npip install frogmouth\n```\n\nOn systems using Homebrew, you can tap into the Textualize tap and install Frogmouth with `brew`:\n\n```\nbrew tap textualize/homebrew\nbrew install frogmouth\n```\n\nWhichever method you use, you should have a `frogmouth` command on your path.\n\n## Running\n\nEnter `frogmouth` at the prompt to run the app, optionally followed by a path to a Markdown file:\n\n```\nfrogmouth README.md\n```\n\nYou can navigate with the mouse or the keyboard.\nUse \u003ckbd\u003etab\u003c/kbd\u003e and \u003ckbd\u003eshift\u003c/kbd\u003e+\u003ckbd\u003etab\u003c/kbd\u003e to navigate between the various controls on screen.\n\n## Features\n\nYou can load README files direct from GitHub repositories with the `gh` command.\nUse the following syntax:\n\n```\nfrogmouth gh textualize/textual\n```\n\nThis also works with the address bar in the app.\nSee the help (\u003ckbd\u003eF1\u003c/kbd\u003e) in the app for details.\n\n## Follow this project\n\nIf this app interests you, you may want to join the Textual [Discord server](https://discord.gg/Enf6Z3qhVr).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextualize%2Ffrogmouth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextualize%2Ffrogmouth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextualize%2Ffrogmouth/lists"}