https://github.com/phpdocumentor/guides
Guides library to parse documentation
https://github.com/phpdocumentor/guides
parser
Last synced: 4 months ago
JSON representation
Guides library to parse documentation
- Host: GitHub
- URL: https://github.com/phpdocumentor/guides
- Owner: phpDocumentor
- License: mit
- Created: 2022-04-06T12:50:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-06T20:08:57.000Z (4 months ago)
- Last Synced: 2025-10-06T22:12:19.775Z (4 months ago)
- Topics: parser
- Language: PHP
- Homepage:
- Size: 5.49 MB
- Stars: 33
- Watchers: 6
- Forks: 15
- Open Issues: 29
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://poser.pugx.org/phpdocumentor/guides-cli/require/php
:alt: PHP Version Require
:target: https://packagist.org/packages/phpdocumentor/guides-cli
.. image:: https://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://docs.phpdoc.org/components/guides/guides/index.html
: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 `__,
and is based on the original code from `Gregwar `__.