├── .gitignore
├── mm
├── edit.png
├── read.png
├── README.md
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | *~
2 | 


--------------------------------------------------------------------------------
/mm:
--------------------------------------------------------------------------------
1 | pandoc -s -t man "$1" | groff -T utf8 -man | ${PAGER:-less}
2 | 


--------------------------------------------------------------------------------
/edit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ashton314/marked-man/HEAD/edit.png


--------------------------------------------------------------------------------
/read.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ashton314/marked-man/HEAD/read.png


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Marked Man
 2 | ==========
 3 | 
 4 | View Markdown files as `man` pages.
 5 | 
 6 | Get you some markdown:
 7 | 
 8 | ![Edit file](edit.png "Edit file")
 9 | 
10 | Read it:
11 | 
12 | ![Read comfortably](read.png "Read comfortably")
13 | 
14 | * * *
15 | 
16 | Usage:
17 | 
18 | ```
19 | $ mm README.md
20 | ```
21 | 
22 | Installation
23 | ------------
24 | 
25 | You will need:
26 | 
27 |  - [Pandoc](http://pandoc.org)
28 |  - groff
29 | 
30 | For macOS users, groff should come pre-installed. You can get Pandoc via [brew](https://brew.sh):
31 | 
32 | ```
33 | $ brew install pandoc
34 | ```
35 | 
36 | After that, put the file `mm` somewhere in your `$PATH`
37 | 
38 | Credits
39 | -------
40 | 
41 | Thanks to all who helped [here](https://stackoverflow.com/questions/51544667/how-do-i-view-markdown-file-like-a-man-page-without-making-a-temporary-file)! (Especially to [L. Scott Johnson](https://stackoverflow.com/users/2183547/l-scott-johnson)!)
42 | 
43 | Author
44 | ------
45 | 
46 | Ashton Wiersdorf
47 | 
48 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 Ashton Wiersdorf
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------