Skip to content

Experimental guides library to parse documentation

License

Notifications You must be signed in to change notification settings

sarahmccarthy123/guides

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PHP Version Require Latest Unstable Version Total Downloads Monthly Downloads

phpDocumentor Guides

Attention!

EXPERIMENTAL: This library is still under heavy development, and should be considered a work in progress project. It is subject to change or removal without notice, including without consideration for backward compatibility.

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

Attribution

This repository was originally forked from the Doctrine rst-parser, and is based on the original code from Gregwar.

About

Experimental guides library to parse documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 86.2%
  • HTML 10.5%
  • Twig 2.9%
  • Other 0.4%