Repository files navigation

Frogmouth is a Markdown viewer / browser for your terminal, built withTextual.

Frogmouth can open*.md files locally or via a URL.There is a familiar browser-like navigation stack, history, bookmarks, and table of contents.

Frogmouth runs on Linux, macOS, and Windows. Frogmouth requires Python3.8 or above.

The easiest way to install Frogmouth is withpipx (particularly if you aren't a Python developer).

pipx install frogmouth

You can also install Frogmouth withpip:

pip install frogmouth

On systems using Homebrew, you can tap into the Textualize tap and install Frogmouth withbrew:

brew tap textualize/homebrewbrew install frogmouth

Whichever method you use, you should have afrogmouth command on your path.

Enterfrogmouth 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.Usetab andshift+tab to navigate between the various controls on screen.

You can load README files direct from GitHub repositories with thegh 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.

If this app interests you, you may want to join the TextualDiscord server.