Teable Help

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where docs.json is)

mintlify dev

Paste Image

Use the Paste Image extension to paste images into the markdown file. Open mdx file and press cmd + option + v to paste image.

Publishing Changes

Push to origin main branch, the changes will be deployed to production automatically.

Troubleshooting

• Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
• Page loads as a 404 - Make sure you are running in a folder with docs.json