API reference + Docs#

A common requirement for expansive documentation sites is having both guides and an API reference.

API reference is a lot more technical and usually isn't very helpful for beginners, but massively helpful if you know the library already and want to fact check something.

The guides is almost the opposite: It's very friendly for beginners, but lacks the completeness of an API reference.

Adding the two sections to your project#

The recommended way to add an API reference next to your guides is to use tabs.

Tabs is a configuration option for a Guider site that allows for easy switching between two contexts.

import { directories, link, defineTheme } from "@neato/guider/theme"
 
export default defineTheme({
  tabs: [
    link("Guides", "/guides"),
    link("API reference", "/api"),
  ]
  directories: [
    directory('guides', {
      sidebar: [
        // your sidebar items
      ],
    }),
    directory('api', {
      sidebar: [
        // your sidebar items
      ],
    })
  ]
})

{
  "directory": "guides"
}

{
  "directory": "api"
}