sample-config.json

{
    "--comment": "File paths are relative to the current working directory. You should run Liaison's bin script from the root of your project folder.",

    "deliver_script": "deliver.php",
    "liaison_variable_name": "lia",
    "scrawl_route": "/",

    "--comment2": "deliver_script is where you setup liaison. liaison_variable_name is the name of the variable containing the liaison instance. scrawl_route is the URL to set REQUEST_URI to while loading the liaison instance.",

    "error_page_file": "generic-error-page.html",
    "error_page_route": "/generic-error/",

    "--comment3": "error_page_file tells liaison where to output your error page. When you want to display your error page, you will 'require' this one file and 'exit'. 'error_page_route' is a route on your site that will display the generic page.",


    "liaison_docs_dir": "Liaison",

    "--comment4": "liaison_docs_dir is required if you use the CodeScrawl extension 'Lia\\Ext\\Scrawl' to generate documentation for your site or app. It must be a relative directory path inside your documentation output directory."
}