Download the PHP package erikaheidi/yamldocs without Composer
On this page you can find all versions of the php package erikaheidi/yamldocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download erikaheidi/yamldocs
More information about erikaheidi/yamldocs
Files in erikaheidi/yamldocs
Package yamldocs
Short Description YAML Reference Builder / Markdown Document Generator
License MIT
Homepage https://yamldocs.dev
Informations about the package yamldocs
yamldocs
Yamldocs is a markdown document generator based on YAML files, written in PHP with Minicli. It can be used as a standalone app or included as a Composer bin command to be used within existing projects. It is useful to create automated reference docs that can be customized through templates and a common builder interface.
Check the documentation website for installation and usage instructions.
Examples
Example YAML
This YAML demonstrates the structure used to define a document and how the markdown is generated:
Building a single document
Generated markdown content:
yaml Section1: Item1: value0 Item2: value1 Item3:
- value12
-
value13 Item4: value2
yaml Section2: Item1:
- value01
- value02
Building multiple documents
Use the build docs
command to build markdown docs for all YAML files in a directory. Add --recursively
to build subdirs.
For more information and detailed usage instructions, check the full docs at https://yamldocs.dev.
All versions of yamldocs with dependencies
minicli/command-help Version ^1.0
symfony/yaml Version ^6.1
minicli/stencil Version ^0.2.1