errors

The errors property in the docmd.config.json file is used to define the error pages that will be displayed when an error occurs. The errors property is an object where the keys are the HTTP status codes and the values are the paths to the error markdown files.

The errors property is an object and is optional in the configuration file.

{
  "$schema": "https://raw.githubusercontent.com/danecwalker/docmd/main/schemas/docmd.schema.json",
  "title": "Docmd",
  "description": "A simple documentation generator for markdown files",
  "errors": {
    "404": "/404.md",
    "500": "/500.md"
  },
  ...
}

The errors property can be set to any markdown file in the documentation. If the errors property is not set, docmd will use the default error pages provided by the theme.

← entry outDir →