.mddoc.xml.dist

<mddoc>
	<autoloader type="psr4" root="src" namespace="donatj\MDDoc"/>
	<docpage target="README.md">

		<section title="MDDoc">
			<badge-poser type="version"/>
			<badge-poser type="downloads"/>
			<badge-poser type="license"/>
			<badge-github-action name="donatj/mddoc" workflow-file="ci.yml"/>

			<text><![CDATA[
A simple, directed markdown documentation generator for PHP projects.

A simple use-case is to generate a README.md based on the project's source code as well as other options as defined in the config file.

This projects allows you to define a set of directives for *how* to document a project, and output to markdown.

This allows everything from README's to entire websites to be generated using this tool.

This is done using a simple, expressive XML syntax. This includes:

- Automatic documentation of code
- Automatic composer requirements / installation instructions
- Raw and code-tag wrapped file inclusion
- Script output
- Automatic Badge Creation
- Creating sub-documents
- Much more

]]></text>
			<section title="Requirements">
				<composer-requires/>
			</section>

			<section title="Examples">
				<text><![CDATA[
- PhpUserAgent's [README](https://github.com/donatj/PhpUserAgent)
- [boomerang.work](https://boomerang.work/) - The documentation site for Boomerang*!* is fully generated using this tool.

This very README you are reading (also including [DOCS.md](DOCS.md)) is generated by the file [.mddoc.xml.dist](.mddoc.xml.dist)
]]></text>
				<replace search="&#x9;" replace="  ">
					<source name=".mddoc.xml.dist" lang="xml"/>
				</replace>
			</section>

			<section title="Full API Docs (WIP)">
				<docpage target="DOCS.md">
					<section title="Full API Docs (WIP)">
						<recursive-directory warn-undocumented="false" name="src"/>
					</section>
				</docpage>
			</section>

			<section title="Configuration Syntax">
				<exec cmd="./bin/document-tags.php"/>
			</section>
		</section>
	</docpage>
</mddoc>