frogmouth-ng 0.9.2

A Markdown document viewer for the terminal

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.

[!NOTE]

This repository is a temporary, maintained fork of Frogmouth. Its purpose is to continue development and resolve issues that currently block usability. The fork exists independently for now but the intent is eventual upstreaming rather than fragmentation.

🎬 Demonstration

---

A quick video tour of Frogmouth.

https://user-images.githubusercontent.com/554369/235305502-2699a70e-c9a6-495e-990e-67606d84bbfa.mp4

(thanks Screen Studio)

Screenshots

Compatibility

Frogmouth runs on Linux, macOS, and Windows. Frogmouth requires Python 3.10 or above.

Installing

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

pipx install frogmouth-ns

You can also install Frogmouth with pip:

pip install frogmouth-ns

[!IMPORTANT]

This package installs the frogmouth command. If you have the original Frogmouth installed, uninstall it first.

[!NOTE]

Homebrew support is not currently provided. If there is sufficient demand, a Homebrew formula may be added in the future. For now, installation is supported via PyPI only.

Homebrew

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

brew tap textualize/homebrew
brew 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.