进行搜索sevenecks / phpmyman
使用 PHP 编写的个人手册页面创建器
Requires
- sevenecks/markdown-terminal: ^0.0.1
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-18 07:39:44 UTC
README
使用此小巧的 PHP 命令行应用程序、VIM 和 Markdown 创建您自己的个人手册页面。它非常简单，您可以使用 composer 全局安装应用程序（您也可以本地安装，但这意味着需要输入更多命令），然后您可以运行 'mm edit topic' 命令，这将从您的终端打开一个 vim 编辑器，允许您输入 Markdown 或纯文本。从那里退出 VIM，您的个人手册页面就被保存了！它将保存在 ~/phpmyman 文件夹中。然后您可以将此文件夹提交到版本控制。要访问您的新手册页面，只需键入 'mm topic'，Markdown 将被解析并直接在您的终端中显示。
请注意。我写这个作为个人项目只是为了好玩，因为我看到有人用 Python 写了一个类似的项目，我想看看我是否能做一些有趣的事情。Markdown 到终端的转换并不完美。主要是因为终端无法可靠地支持 Markdown 尝试做的一切。所以，这是一个尽力而为的尝试。
总之，这只是一个使用 VIM 的简单笔记应用程序。它并不特别。但您可能觉得它有用。
安装
通过 Composer
全局
composer global require sevenecks/phpmyman
本地
composer require sevenecks/phpmyman
命令行界面使用
全局安装
显示应用程序的帮助信息
mm
添加新的个人手册页面
mm edit mypage
查看您的新个人手册页面
mm mypage
列出您的个人手册页面
mm list
本地安装
如果您所在的系统中的 hosts 文件位于 /etc/hosts，则无需进行进一步配置。如果不是，那么您应该进入 vendor 文件夹，将 .env-example 文件复制到 .env 并编辑它以指向您的 hosts 文件。然后您可以继续。
./vendor/bin/mm
PhpMyMan 页面
这些页面将位于您的家目录的 /phpmyman 目录中。
贡献
有关详细信息，请参阅CONTRIBUTING 和 CODE_OF_CONDUCT。
安全
如果您发现任何安全相关的问题，请通过电子邮件 bbutts@stormcode.net 而不是使用问题跟踪器。
鸣谢
变更日志
有关更多信息，请参阅变更日志。
许可证
MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件。