Frogmouth
Frogmouth is a Markdown viewer / browser for your terminal, built with 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.
Screenshots
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 (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 tab and shift+tab 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 (F1) in the app for details.
Follow this project
If this app interests you, you may want to join the Textual Discord server.