defaults.json

{

    "--comments":{
        "Documentation": "Visit https://www.taeluf.com/docs/Code%20Scrawl or https://gitlab.com/taeluf/php/CodeScrawl",
        "Deprecation 1":"Version 1.0 will scan src/ & test/ ",
        "Deprecation 2":"Version 1.0 will default to non-hidden directories 'docsrc' and 'doctemplate'",
        "Deprecation 3":"Version 1.0 will fully-default to 'config/' dir rather than '.config/', though both will still work.",

        "Addition 1": "2023-12-23: Added 'api.output_dir = 'api/' config. If `null`, then do not write api output files. Previously, APIs were ALWAYS output to the api/ dir. Default config has the same behavior as before.",
        "Addition 2": "2023-12-23: Add api.generate_readme config (default TRUE). This is NEW Functionality that creates a README in the api/ dir."
    },

    "template.dirs": [".doctemplate"],

    "dir.docs": "docs",
    "dir.src": ".docsrc",
    "dir.scan": ["code", "test"],

    "api.output_dir": "api/",
    "api.generate_readme": true,


    "ScrawlExtensions":[],

    "file.bootstrap":"scrawl-bootstrap.php",

    "deleteExistingDocs": false,
    "readme.copyFromDocs": false,

    "markdown.preserveNewLines": true,
    "markdown.prependGenNotice": true
}