Co-authored by
Hayden BleaselJTBDOS
Flo MerianMintlify
A preview of docs
The docs application runs on port 3004. We recommend deploying it to docs.{yourdomain}.com.
JTBDOS uses Mintlify to generate beautiful docs. Each page is a .mdx file, written in Markdown, with built-in UI components and API playground.

​
Creating a new page

To create a new documentation page, add a new MDX file to the apps/docs directory. The file name will be used as the slug for the page and the frontmatter will be used to generate the docs page. For example:
apps/docs/hello-world.mdx
---
title: 'Quickstart'
description: 'Start building modern documentation in under five minutes.'
---
Learn more supported meta tags.

​
Adding a page to the navigation

To add a page to the sidebar, you’ll need to define it in the mint.json file in the apps/docs directory. From the previous example, here’s how you can add it to the sidebar:
mint.json
"navigation": [
  {
    "group": "Getting Started",
    "pages": ["hello-world"]
  },
  {
    // ...
  }
]

​
Advanced

You can build the docs you want with advanced features.

Global Settings

Customize your documentation using the mint.json file

Components

Explore the variety of components available