leiame.md

Iquety Docmap

English	Português

Sinopse

O Docmap é uma ferramenta que gera um menu de navegação em documentações baseadas em markdown. É muito útil para facilitar a navegabilidade e adicionar mais profissionalismo às documentações de repositórios ou bibliotecas.

composer require iquety/docmap

Abaixo, um exemplo do menu que o Docmap desenha nos documentos:

◂ Mono mono	Back to index	Nom monon ▸

Para usar, basta instalar e executar no Terminal:

// interpreta o diretório 'src-docs' e salva em 'docs'
vendor/bin/docmap -s src-docs -d docs

Para informações detalhadas, consulte o Sumário da Documentação.

Características

• Feito para o PHP 8.0 ou superior;
• Codificado com boas práticas e máxima qualidade;
• Bem documentado e amigável para IDEs;
• Feito com TDD (Test Driven Development);
• Implementado com testes de unidade usando PHPUnit;
• Feito com ❤️ & ☕.

Creditos

Ricardo Pereira Dias