https://github.com/0mp/mantra
CLI for live preview of mandoc manual pages for documentation contributors.
https://github.com/0mp/mantra
auto-reload autoreload live-reload mandoc manpage manpages pager
Last synced: about 1 year ago
JSON representation
CLI for live preview of mandoc manual pages for documentation contributors.
- Host: GitHub
- URL: https://github.com/0mp/mantra
- Owner: 0mp
- License: other
- Created: 2021-10-12T14:49:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-18T15:38:00.000Z (over 3 years ago)
- Last Synced: 2025-03-29T04:12:07.782Z (about 1 year ago)
- Topics: auto-reload, autoreload, live-reload, mandoc, manpage, manpages, pager
- Language: Shell
- Homepage:
- Size: 4.88 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mantra
Mantra is a CLI for previewing [mandoc](https://mandoc.bsd.lv/) manual pages with live auto-reload in a pager.
## Installation
Dependencies:
- [`entr`](http://eradman.com/entrproject/) (for watching file changes)
- [`less`](https://www.greenwoodsoftware.com/less/) (Less is the only supported pager at the moment)
- [`tmux`](https://github.com/tmux/tmux/wiki) (for scripting pager interactions)
```sh
make all
PREFIX=/usr/local make install
```
## Usage
```sh
mantra style.9
```
## License
BSD 2-Clause "Simplified" License