iquety/docmap

简单的Markdown文件解释器,在每个页面上添加导航菜单

维护者

详细信息

github.com/iquety/docmap

源代码

问题

安装次数: 1,589

依赖者: 8

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 0

开放性问题: 0

类型:工具

v2.0.2 2024-09-16 14:01 UTC

This package is auto-updated.

Last update: 2024-09-16 14:37:09 UTC


README

PHP Version License Codacy Grade Codacy Coverage

简介

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实现单元测试;
  • 用❤️ & ☕制作。

鸣谢

Ricardo Pereira Dias