supersamples.opts

{

  //
  // Supersamples options
  // Note: all paths are relative to where Mocha is executed
  //


  // Base URL for all API calls (used in CURL examples)
  "baseUrl": "http://my-api.com",

  // Mocha reporter to display test results
  // e.g. Dot, TAP, Spec...
  "reporter": "Dot",

  //
  // Renderers
  //

  "renderers": {


    //
    // Full HTML website
    //

    "html": {

      // Output folder
      "outputFolder": "example-docs",

      // Documentation page title
      "title": "API documentation",

      // Optional Markdown document used at the top of the docs
      // Heading levels 1 and 2 are appended to the navigation
      "intro": "example/docs/intro.md",

      // Extra files to be copied into the output folder (css, logos, htaccess...)
      // <key> is a glob pattern to a list of files
      // <value> is the target folder inside of the configured output
      "files": {
        "example/docs/files/**": "."
      },

      // Paths to custom CSS files, relative to the output folder
      // These must have been copied as part of "files"
      "styles": [
        "custom.css"
      ]

    },


    //
    // Single JSON file with all the samples metadata
    //

    "json": {

      // Output file path
      "outputFile": "example-docs/samples.json",
      "includeBuffers": false

    },

    "postman": {

      // Output file path
      "outputFile": "example-docs/samples.json",
      "title": "Postman Collection Title",
      "version": 2, // others not supported at the moment
      "generateTests": true,
      "replace": {
        "headers": {},
        "body": {}
      },
      "additionalItems": []
    },


    //
    // Single Markdown file
    //

    "markdown": {

      // Output file path
      "outputFile": "example-docs/samples.md"

    }


  }

}