..  image:: https://poser.pugx.org/phpdocumentor/guides-markdown/require/php
    :alt: PHP Version Require
    :target: https://packagist.org/packages/phpdocumentor/guides-markdown

..  image:: https://poser.pugx.org/phpdocumentor/guides-markdown/v/stable
    :alt: Latest Stable Version
    :target: https://packagist.org/packages/phpdocumentor/guides-markdown

..  image:: https://poser.pugx.org/phpdocumentor/guides-markdown/v/unstable
    :alt: Latest Unstable Version
    :target: https://packagist.org/packages/phpdocumentor/guides-markdown

..  image:: https://poser.pugx.org/phpdocumentor/guides-markdown/d/total
    :alt: Total Downloads
    :target: https://packagist.org/packages/phpdocumentor/guides-markdown

..  image:: https://poser.pugx.org/phpdocumentor/guides-markdown/d/monthly
    :alt: Monthly Downloads
    :target: https://packagist.org/packages/phpdocumentor/guides-markdown

====================
phpDocumentor Guides
====================

This repository is part of `phpDocumentor's Guides library <https://github.com/phpDocumentor/guides>`__, a framework
designed to take hand-written documentation in code repositories and create an AST (abstract syntax tree) from it.
This AST is then fed to a renderer, which produces the desired output, such as HTML.

The package `phpdocumentor/guides-markdown <https://packagist.org/packages/phpdocumentor/guides-markdown>`__ adds
Markdown support to the phpDocumentor's Guides library.

:Mono-Repository:   https://github.com/phpDocumentor/guides
:Documentation:     https://docs.phpdoc.org/components/guides/guides/index.html
:Packagist:         https://packagist.org/packages/phpdocumentor/guides-markdown
:Contribution:      https://github.com/phpDocumentor/guides/tree/main/CONTRIBUTING.rst