iquety/docmap

Simple Markdown file interpreter, which adds a navigation menu on every page

v2.2.0 2026-03-13 19:36 UTC

Requires

• php: ^8.4
• iquety/console: *

Requires (Dev)

• codacy/coverage: dev-master
• friendsofphp/php-cs-fixer: ^3.94
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1.8
• phpunit/phpunit: ^9.5

MIT

• framework
• console
• tool

README

English	Português

Sinopse

Docmap is a tool that generates a navigation menu in markdown-based documentation. It is very useful to facilitate navigability and add more professionalism to the documentation of repositories or libraries.

composer require iquety/docmap

Below is an example of the menu that Docmap draws in documents:

◂ Mono mono	Back to index	Nom monon ▸

To use, just install and run in Terminal:

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

For detailed information, see Documentation Summary.

Characteristics

• Codified with best practices and maximum quality;
• Well documented and IDE friendly;
• Made with TDD (Test Driven Development);
• Implemented with unit tests using PHPUnit;
• Made with ❤️ & ☕.

Credits

Ricardo Pereira Dias