ricardopedias / freep-docmap
Simple Markdown file interpreter, which adds a navigation menu on every page
Installs: 987
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:tool
Requires
- php: ^8.0.0
- ricardopedias/freep-console: dev-main
Requires (Dev)
- codacy/coverage: dev-master
- phpmd/phpmd: @stable
- phpstan/phpstan: ^0.12
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: 3.*
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 ricardopedias/freep-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:
// 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 ❤️ & ☕.