ricardopedias/freep-docmap

简单的Markdown文件解释器，为每个页面添加导航菜单

维护者

详细信息

github.com/ricardopedias/freep-docmap

源代码

问题

安装: 986

依赖: 2

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

公开问题: 0

类型:工具

v1.0.1 2022-08-24 17:07 UTC

Requires

Requires (Dev)

MIT 003d67b32ee001fe70232f24ad532c3ee6f1d05b

frameworkconsoletoolfreep

This package is auto-updated.

Last update: 2024-09-26 22:21:41 UTC

README

PHP Version License Codacy Badge Codacy Badge

简介

Docmap 是一个生成基于Markdown文档的导航菜单的工具。它对于方便导航并使仓库或库的文档更加专业非常有用。

composer require ricardopedias/freep-docmap

以下是Docmap在文档中绘制的菜单示例

使用方法：只需安装并在终端中运行

// install the package
$ composer require ricardopedias/freep-docmap

// interpret 'src-docs' directory and save to 'docs'
$ vendor/bin/docmap -s src-docs -d docs

有关详细信息，请参阅 文档概要。

特性

  • 适用于PHP 8.0或更高版本；
  • 使用最佳实践和最高质量编码；
  • 文档齐全，且与IDE兼容；
  • 采用TDD（测试驱动开发）；
  • 使用PHPUnit实现单元测试；
  • 用❤️ & ☕ 制作。

致谢

Ricardo Pereira Dias