README

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 ricardopedias/freep-docmap

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

To use, just install and run in Terminal:

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

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

For detailed information, see Documentation Summary.

Characteristics

• Made for PHP 8.0 or higher;
• 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