phpDocumentor / guides

Guides library to parse documentation
MIT License
30 stars 15 forks source link
parser

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

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

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

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

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

phpDocumentor's Guides library is 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. The Guides library is flexible, allowing you to plug in support for various input formats, such as Restructured Text, and output formats, such as HTML.

:Mono-Repository: https://github.com/phpDocumentor/guides :Documentation: https://github.com/phpDocumentor/guides/tree/main/docs/index.rst :Packagist: https://packagist.org/packages/phpdocumentor/guides

You can try out this reposistory convieniently in GitPod by clicking this button:

.. image:: https://gitpod.io/button/open-in-gitpod.svg :alt: Try out in GitPod :target: http://gitpod.io/#/https://github.com/phpDocumentor/guides

Attribution

This repository was originally forked from the Doctrine rst-parser <https://github.com/doctrine/rst-parser>, and is based on the original code from Gregwar <https://github.com/Gregwar/RST>.