{"repo":"Chris1221/yamldoc","free":true,"listed":false,"github":"https://github.com/Chris1221/yamldoc","clone":"git clone https://github.com/Chris1221/yamldoc.git","description":"Dependency-free YAML documentation engine.","language":"Python","stars":12,"topics":["yaml","markdown"],"license":"MIT","category":"cli-tools","readme_excerpt":"Documentation Engine for YAML This package converts a YAML file into markdown, formatting values and associated metadata in a doxygen -like way. To get started, check out the documentation and tutorials. Installation This will install the python package, which contains a command line interface yamldoc . To see usage instructions, invoke the --help flag: Note: pip = 23.0 is required. If you see the package install as UNKNOWN , upgrade pip first: pip install --upgrade pip Features and Supported Syntax yamldoc does not support the full syntax of YAML, which is vast and complex. Instead, it supports a subset of YAML that is useful for documenting configuration files. This subset includes: Syntax Supported Description --- --- --- key: value Yes Basic key-value pairs. Values can be any type and are not subject to coercion. (i.e. yes will remain yes in yamldoc output. It will not be coerced to True as a YAML parser would. The goal of yamldoc is to be transparent , not feature complete. key: [value1, value2, ...] Yes Arrays are understood by yamldoc if they are either listed on one line or each entry given on a new line with dashes to indicate entries. Comments Yes Non- yamldoc comments are ignored. yamldoc comments are indicated by a special character (default #' ) at the beginning of the line. yamldoc comments can be broken over as many lines as you like, they will be added together when the markdown is constructed. Things YAML does not support: - Multi-line strings (unquoted or qu","default_branch":null,"files":null,"tree":[],"storefront":"/r/Chris1221","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Chris1221/yamldoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}