https://github.com/chubek/mukette
A TUI Pager for Markdown, a tool similar to man(1) or most(1), but renders Markdown in-terminal
https://github.com/chubek/mukette
commandline flex floss gpl gplv3 lex libre ncurses opensource parse termcap terminal tui
Last synced: about 1 month ago
JSON representation
A TUI Pager for Markdown, a tool similar to man(1) or most(1), but renders Markdown in-terminal
- Host: GitHub
- URL: https://github.com/chubek/mukette
- Owner: Chubek
- License: other
- Created: 2024-01-31T00:44:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-19T10:24:54.000Z (about 1 year ago)
- Last Synced: 2025-03-31T22:05:46.303Z (3 months ago)
- Topics: commandline, flex, floss, gpl, gplv3, lex, libre, ncurses, opensource, parse, termcap, terminal, tui
- Language: C
- Homepage:
- Size: 151 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mukette: A Pager for Markdown, for UNIX-based Systems
A 'pager' is a utility that takes a markup text (say, Roff) and displays that text, formatted, in the terminal. The first pager was `nroff(1)` for the aforementioned Roff, and you may still find `nroff(1)` on UNIX-based systems.
Mukette follows the same template. You pass it one, or several Markdown files, and it pages them. For example, you may use `example-document.md` to test Mukette.
```
mukette example-document.md
```
## Installing
You need ncurses and Flex to build Mukette. ncurses is probably already on your system. But just to be safe:
```
sudo apt-get install ncurses-dev flex
```
And then in the the root directory, run `make` and `make install`:
```
make && sudo make install
```
The man page will be installed alongside. The man page contains all the info about using Mukette:
```
man 1 mukette
```
## Disclaimer
Mukette is a v1 product, it still has a lot of rough edges. Report any bugs to Issues tab in the Github repository.
## Windows
On Windows you can use WSL2 or CygWin/MSys.