<p align="center">
<img src="https://user-images.githubusercontent.com/554369/234892488-856f9da7-7b82-4429-ac35-0d0545bf0d24.png" width="300" align="center"/>
</p>
[](https://discord.gg/Enf6Z3qhVr)
# Frogmouth
Frogmouth is a Markdown viewer / browser for your terminal, built with [Textual](https://github.com/Textualize/textual).
Frogmouth can open `*.md` files locally or via a URL.
There is a familiar browser-like navigation stack, history, bookmarks, and table of contents.
<details>
<summary> 🎬 Demonstration </summary>
<hr>
A quick video tour of Frogmouth.
https://user-images.githubusercontent.com/554369/235305502-2699a70e-c9a6-495e-990e-67606d84bbfa.mp4
(thanks [Screen Studio](https://www.screen.studio/))
</details>
## Screenshots
<table>
<tr>
<td>
<img 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">
</td>
<td>
<img 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">
</td>
</tr>
<tr>
<td>
<img 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">
</td>
<td>
<img 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">
</td>
</tr>
</table>
## Compatibility
Frogmouth runs on Linux, macOS, and Windows. Frogmouth requires Python **3.8** or above.
## Installing
The easiest way to install Frogmouth is with [pipx](https://pypa.github.io/pipx/) (particularly if you aren't a Python developer).
```
pipx install frogmouth
```
You can also install Frogmouth with `pip`:
```
pip install frogmouth
```
Whichever method you use, you should have a `frogmouth` command on your path.
## Running
Enter `frogmouth` at the prompt to run the app, optionally followed by a path to a Markdown file:
```
frogmouth README.md
```
You can navigate with the mouse or the keyboard.
Use <kbd>tab</kbd> and <kbd>shift</kbd>+<kbd>tab</kbd> to navigate between the various controls on screen.
## Features
You can load README files direct from GitHub repositories with the `gh` command.
Use the following syntax:
```
frogmouth gh textualize/textual
```
This also works with the address bar in the app.
See the help (<kbd>F1</kbd>) in the app for details.
## Follow this project
If this app interests you, you may want to join the Textual [Discord server](https://discord.gg/Enf6Z3qhVr).
Raw data
{
"_id": null,
"home_page": "https://github.com/Textualize/frogmouth",
"name": "frogmouth",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Dave Pearson",
"author_email": "dave@textualize.io",
"download_url": "https://files.pythonhosted.org/packages/75/2e/747826187029cd9fae0761573d5ebf3566417b0bc4d8ed1caafa9bd8819f/frogmouth-0.9.2.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <img src=\"https://user-images.githubusercontent.com/554369/234892488-856f9da7-7b82-4429-ac35-0d0545bf0d24.png\" width=\"300\" align=\"center\"/>\n</p>\n\n[](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<details> \n <summary> \ud83c\udfac Demonstration </summary>\n <hr>\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</details>\n\n## Screenshots\n\n<table>\n\n<tr>\n<td>\n<img 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\">\n</td>\n\n<td>\n<img 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\">\n</td>\n</tr>\n\n<tr>\n\n<td>\n<img 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\">\n</td>\n\n<td>\n<img 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\">\n</td>\n\n</tr>\n\n</table>\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\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 <kbd>tab</kbd> and <kbd>shift</kbd>+<kbd>tab</kbd> 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 (<kbd>F1</kbd>) 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",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Markdown document viewer for the terminal",
"version": "0.9.2",
"project_urls": {
"Homepage": "https://github.com/Textualize/frogmouth"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e20a95a9cacac3a52742399fb4ece28e3d8c5c1d5a2c161dd548821350a0aec5",
"md5": "a505945f7bd75b2aefd60b35438ae524",
"sha256": "c56d4047653c02d3c4aef052aa226fc537272bfbd88c6627e1ee17b4c2510973"
},
"downloads": -1,
"filename": "frogmouth-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a505945f7bd75b2aefd60b35438ae524",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 39550,
"upload_time": "2023-11-28T15:46:56",
"upload_time_iso_8601": "2023-11-28T15:46:56.197164Z",
"url": "https://files.pythonhosted.org/packages/e2/0a/95a9cacac3a52742399fb4ece28e3d8c5c1d5a2c161dd548821350a0aec5/frogmouth-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "752e747826187029cd9fae0761573d5ebf3566417b0bc4d8ed1caafa9bd8819f",
"md5": "b4dfac8f90dd926bc38654e63ae70405",
"sha256": "0e8724cff43f6fe50408595936281d4d4b65b14c456d26e7ba7c401428812f08"
},
"downloads": -1,
"filename": "frogmouth-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "b4dfac8f90dd926bc38654e63ae70405",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 28014,
"upload_time": "2023-11-28T15:46:57",
"upload_time_iso_8601": "2023-11-28T15:46:57.745047Z",
"url": "https://files.pythonhosted.org/packages/75/2e/747826187029cd9fae0761573d5ebf3566417b0bc4d8ed1caafa9bd8819f/frogmouth-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 15:46:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Textualize",
"github_project": "frogmouth",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "frogmouth"
}
JSON
