README

Create your own personal man pages using this tiny PHP cli app, VIM, and Markdown. It's pretty straight forward, you install the application globally using composer (you can install it locally but it means more typing), you can then run 'mm edit topic' which will open a vim editor from your terminal, allowing you to enter markdown or plain text. From there you exit VIM and your personal man page is saved! It will be saved in the ~/phpmyman folder. You can then commit this folder to version control. To access your new man page, just type 'mm topic' and the markdown will be parsed and displayed right there in your terminal.

A word of warning. I wrote this as a personal project for fun, because I saw someone had written something similar in Python and it seemed like a fun thing to see if I could do. The Markdown to Terminal conversion is not 100%. Mainly because terminals don't reliably support everything Markdown tries to do. So, it's a best effort.

In this end, this is nothing more than a little note taking application that uses VIM. It's not special. But, you might find it useful.

Installation

Via Composer

Global

composer global require sevenecks/phpmyman

Local

composer require sevenecks/phpmyman

CLI Usage

Global Install

Show the help for the app:

mm

Add a new personal man page:

mm edit mypage

View your new personal man page:

mm mypage

List your personal man pages:

mm list

Local Install

If you are on a system where the hosts file is located at /etc/hosts then you have no further configuration to do. If you are not, then you should go into the vendor folder, copy the .env-example file to .env and edit it to point to your hosts file. Then you can proceed.

./vendor/bin/mm

PhpMyMan Pages

These pages will be located in the /phpmyman directory of your home directory.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email bbutts@stormcode.net instead of using the issue tracker.

sevenecks / phpmyman

Maintainers

Details