PHPackages                             dantleech/docbot - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. dantleech/docbot

ActiveLibrary[Utility & Helpers](/categories/utility)

dantleech/docbot
================

693[9 issues](https://github.com/dantleech/docbot/issues)PHP

Since Aug 23Pushed 8mo ago1 watchersCompare

[ Source](https://github.com/dantleech/docbot)[ Packagist](https://packagist.org/packages/dantleech/docbot)[ RSS](/packages/dantleech-docbot/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

DTL Docbot
==========

[](#dtl-docbot)

Docbot **generates** up-to-date and accurate documentation by **executing** the documentation.

Status
------

[](#status)

I've hacked this together in 8 hours.

How it works
------------

[](#how-it-works)

Essentially:

- You provide an article containing a set of delarative blocks.
- The blocks are executed output is captured.
- The documentation is rendered to a format of your choice (e.g. markdown).

Features
--------

[](#features)

- Create and update files.
- Execute shell commands and capture the output.
- Apply assertions on the result of an executed block.
- Add your own extensions to provide custom blocks.
- Easily customise the output format to suit your project (e.g. Markdown, Hugo, RsT, HTML, whatever).
- Depend on other documents (pre-requisites).
- Interact with web pages and capture screenshots (*planned*).
- Lots of other stuff that I haven't done yet.

Usage
-----

[](#usage)

Create the following file at `docs/example.php`:

```