hapi-docs icon indicating copy to clipboard operation
hapi-docs copied to clipboard

Ability to document miscellaneous information

Open antony opened this issue 4 years ago • 0 comments

It would be very useful if there was a way to document "extra information", such as how to build CDN urls, for example.

I would suggest this is added much like errors, auth, etc, as an array of optional pages which could be inserted into the docs, i.e:

{ plugin: HapiDocs,
      options: {
        pages: [
          {
            name: 'CDN Urls',
            title: 'Some page title here'
            descriptions: [
              "Some different pararaphs go here",
              "Relating to the subject matter"
            ]
          }
        ],
        ...
      }
}

antony avatar Aug 20 '19 06:08 antony