header.md

Introduction

This example documentation contains all the possible configuration options for apidoc.

To generate this documentation:

git clone https://github.com/apidoc/apidoc && cd apidoc
npm install --prod
./bin/apidoc -i example -o /tmp/doc
$BROWSER /tmp/doc

Note that this text is from the file "header.md".

Adding a header

In your projects "package.json" you can set "apidoc.header" with a title and a filename to include this file into your documentation.

This example configuration attempts to integrate "header.md" and "footer.md".

{
  "name": "example",
  "version": "0.3.0",
  "description": "apidoc example project.",
  "apidoc": {
    "header": {
      "title": "Introduction",
      "filename": "header.md"
    },
    "footer": {
      "title": "Best practices",
      "filename": "footer.md"
    }
  }
}