A Markdown document viewer for the terminal
Project description
Frogmouth
Frogmouth is a terminal-based Markdown viewer / browser, built with Textual.
Frogmouth can view *.md
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)
Screenshots
Installing
The easiest way to install Frogmouth is probably via pipx (particularly if you aren't a Python developer).
pipx install frogmouth
You can also install it via 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
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 view local files from the command line with this:
frogmouth README.md
You can also load README files 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for frogmouth-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ec8e41f5373bcf0eea0648d2b174e6bdef97aff8fb9964b6c92d7b3428c02b6 |
|
MD5 | f7cdb9b5accd7c6bf473ab11fe4b86cc |
|
BLAKE2b-256 | e9d55793e49cdca528254a7a6f1a566f4208c6f3f8716991832440aa99524074 |