Night Owl logoNight Owl

Default options

These are Night Owl’s default configuration options.

The defaults are defined in night-owl/lib/config/defaults.js. The file also contains type definitions which you can import into your own configuration.

{
  "src": "src",
  "dist": "dist",
  "host": "0.0.0.0",
  "port": 8080,
  "templates": {
    "include": [],
    "exclude": [ "**/_*", "**/.*", "**/_*/**" ]
  },
  "copy": [],
  "watch": [],
  "watchAndRestart": [ "package.json" ],
  "transform": [],
  "trailingSlash": true,
  "excludeHidden": true,
  "clear": false,
  "compilers": {
    "templatejs": {
      "ext": [ ".template.js", ".template.ts" ]
    },
    "clientjs": {
      "ext": [ ".client.js", ".client.ts" ]
    },
    "css": {
      "ext": [ ".css" ]
    },
    "sass": {
      "ext": [ ".sass", ".scss" ]
    },
    "markdown": {
      "ext": [ ".md" ]
    },
    "yaml": {
      "ext": [ ".yaml", ".yml" ]
    },
    "json": {
      "ext": [ ".json" ]
    },
    "pug": {
      "ext": [ ".pug" ]
    },
    "handlebars": {
      "ext": [ ".hbs", ".handlebars" ]
    }
  },
  "stripSortPrefix": true,
  "importThreshold": 9999,
  "maxLayoutDepth": 10,
  "tempDirectory": ".nightowl",
  "logger": {
    "fail": true,
    "info": true,
    "time": false,
    "warn": true
  }
}
Page data

This page was rendered with the following data.

{
  "layout": "docs/03-configuration/defaults/_layout.pug",
  "menu": {...},
  "filters": {...},
  "helpers": {...},
  "version": "0.5.4",
  "github": "https://github.com/stephenhutchings/night-owl/",
  "npm": "https://www.npmjs.com/package/night-owl",
  "hash": "lmu1z5z4",
  "thumbnail": "https://night-owl.s-ings.com/assets/thumb.png",
  "isDev": false,
  "tags": [ "advanced" ],
  "json": "{\n  \"src\": \"src\",\n  \"dist\": \"dist\",\n  \"host\": \"0.0.0.0\",\n  \"port\": 8080,\n  \"temp...",
  "title": "Default options",
  "description": "Night Owl's default configuration options",
  "url": "/docs/configuration/defaults/",
  "meta": {
    "url": "/docs/configuration/defaults/",
    "src": "src/docs/03-configuration/defaults/index.template.js",
    "dist": "dist/docs/configuration/defaults/index.html",
    "collections": {
      "all": [...],
      "intro": [...],
      "commands": [...],
      "configuration": [...],
      "advanced": [...],
      "templates": [...]
    }
  }
}