Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 2 months 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 (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-29T18:28:39.000Z (3 months ago)
- Last Synced: 2024-03-29T19:33:33.364Z (3 months ago)
- Topics: markdown, markdown-viewer, python, terminal-based, textual, tui
- Language: Python
- Homepage: https://www.textualize.io/
- Size: 697 KB
- Stars: 2,212
- Watchers: 12
- Forks: 36
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Lists
- awesome-textualize-projects - Frogmouth - A Markdown browser for your terminal. (Community / Third Party Applications)
- cli-apps - Frogmouth - A Markdown viewer / browser for the terminal. (<a name="markdown"></a>Markdown)
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-tuis - frogmouth
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-starred - frogmouth
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-stars - Textualize/frogmouth - `★2307` A Markdown browser for your terminal (Python)
- awesome-stars - frogmouth
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- jimsghstars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-stars - Textualize/frogmouth - `★2016` A Markdown browser for your terminal (Python)
- awesome-stars - Textualize/frogmouth - A Markdown browser for your terminal (Python)
- awesome-cli-apps - Frogmouth - A Markdown viewer / browser for the terminal. (<a name="markdown"></a>Markdown)
README
[](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).