iquety / docmap
简单的Markdown文件解释器,在每个页面上添加导航菜单
v2.0.2
2024-09-16 14:01 UTC
Requires
- php: ^8.3
- iquety/console: *
Requires (Dev)
- codacy/coverage: dev-master
- phpmd/phpmd: @stable
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: 3.*
README
简介
Docmap是一个生成基于Markdown文档的导航菜单的工具。它对于方便导航和提升仓库或库的文档专业性非常有用。
composer require iquety/docmap
以下是Docmap在文档中绘制的菜单示例
使用方法:只需安装并在终端中运行
// interpret 'src-docs' directory and save to 'docs' vendor/bin/docmap -s src-docs -d docs
有关详细信息,请参阅文档摘要。
特点
- 适用于PHP 8.3或更高版本;
- 采用最佳实践和最高质量编码;
- 文档完善且IDE友好;
- 采用TDD(测试驱动开发);
- 使用PHPUnit实现单元测试;
- 用❤️ & ☕制作。