{"id":19044181,"url":"https://github.com/sevenecks/phpmyman","last_synced_at":"2026-05-09T16:30:21.893Z","repository":{"id":62542746,"uuid":"148831759","full_name":"sevenecks/phpmyman","owner":"sevenecks","description":"Create your own personalized little man pages using markdown with this tiny PHP command line app.","archived":false,"fork":false,"pushed_at":"2018-09-17T18:15:02.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-02T08:14:27.839Z","etag":null,"topics":["cli","composer","man","markdown","php","vim"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sevenecks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-14T19:14:41.000Z","updated_at":"2023-02-14T01:05:22.000Z","dependencies_parsed_at":"2022-11-02T16:16:12.175Z","dependency_job_id":null,"html_url":"https://github.com/sevenecks/phpmyman","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sevenecks%2Fphpmyman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sevenecks%2Fphpmyman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sevenecks%2Fphpmyman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sevenecks%2Fphpmyman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sevenecks","download_url":"https://codeload.github.com/sevenecks/phpmyman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240100558,"owners_count":19747689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","composer","man","markdown","php","vim"],"created_at":"2024-11-08T22:45:07.809Z","updated_at":"2026-05-09T16:30:21.836Z","avatar_url":"https://github.com/sevenecks.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PhpMyMan\n\n[![Latest Version on Packagist][ico-version]][link-packagist]\n[![Software License][ico-license]](LICENSE.md)\n[![Build Status][ico-travis]][link-travis]\n[![Coverage Status][ico-scrutinizer]][link-scrutinizer]\n[![Quality Score][ico-code-quality]][link-code-quality]\n[![Total Downloads][ico-downloads]][link-downloads]\n\nCreate 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.\n\nA 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.\n\nIn 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.\n\n## Installation\n\nVia Composer\n\n### Global\n\n```bash\ncomposer global require sevenecks/phpmyman\n```\n\n### Local\n```bash\ncomposer require sevenecks/phpmyman\n```\n\n### CLI Usage\n\n#### Global Install\n\nShow the help for the app:\n```bash\nmm\n```\n\nAdd a new personal man page:\n```bash\nmm edit mypage\n```\n\nView your new personal man page:\n```bash\nmm mypage\n```\n\nList your personal man pages:\n```bash\nmm list\n```\n\n#### Local Install\nIf 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.\n\n```bash\n./vendor/bin/mm\n```\n\n## PhpMyMan Pages\nThese pages will be located in the /phpmyman directory of your home directory.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.\n\n## Security\n\nIf you discover any security related issues, please email bbutts@stormcode.net instead of using the issue tracker.\n\n## Credits\n\n- [Brendan Butts][link-author]\n- [All Contributors][link-contributors]\n\n## Change Log\nPlease see [Change Log](CHANGELOG.md) for more information.\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n[ico-version]: https://img.shields.io/packagist/v/sevenecks/phpmyman.svg?style=flat-square\n[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[ico-travis]: https://img.shields.io/travis/sevenecks/phpmyman/master.svg?style=flat-square\n[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/sevenecks/phpmyman.svg?style=flat-square\n[ico-code-quality]: https://img.shields.io/scrutinizer/g/sevenecks/phpmyman.svg?style=flat-square\n[ico-downloads]: https://img.shields.io/packagist/dt/sevenecks/phpmyman.svg?style=flat-square\n\n[link-packagist]: https://packagist.org/packages/sevenecks/phpmyman\n[link-travis]: https://travis-ci.org/sevenecks/phpmyman\n[link-scrutinizer]: https://scrutinizer-ci.com/g/sevenecks/phpmyman/code-structure\n[link-code-quality]: https://scrutinizer-ci.com/g/sevenecks/phpmyman\n[link-downloads]: https://packagist.org/packages/sevenecks/phpmyman\n[link-author]: https://github.com/sevenecks\n[link-contributors]: ../../contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsevenecks%2Fphpmyman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsevenecks%2Fphpmyman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsevenecks%2Fphpmyman/lists"}