Skip to content

Docable ⚙️

October 30, 2019 | 04:06 AM

CI for documentation: Testing if documentation/tutorial is runable.

example report

To test a tutorial, you can write docable steps:

setup:
#  local: {}  
  slim:
    image: ubuntu16.04-php

unix-service.md: 
  steps:
    - selectAsFile: ROT13 transformation => server.php
    - selectAndServe: "start it:"
    - selectAndExpect: "another terminal:"

Then execute these tests to generate docable report:

docable report steps.yml