https://github.com/textualize/frogmouth

A Markdown browser for your terminal
https://github.com/textualize/frogmouth

markdown markdown-viewer python terminal-based textual tui

Last synced: 3 days ago
JSON representation

A Markdown browser for your terminal

• Host: GitHub
• URL: https://github.com/textualize/frogmouth
• Owner: Textualize
• License: mit
• Created: 2023-04-03T08:41:03.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T06:51:47.000Z (6 months ago)
• Last Synced: 2025-01-07T16:01:46.431Z (17 days ago)
• Topics: markdown, markdown-viewer, python, terminal-based, textual, tui
• Language: Python
• Homepage: https://www.textualize.io/
• Size: 697 KB
• Stars: 2,617
• Watchers: 12
• Forks: 47
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  



[![Discord](https://img.shields.io/discord/1026214085173461072)](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.

  

   🎬 Demonstration 

  


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/))

## 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](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

```

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](https://discord.gg/Enf6Z3qhVr).