https://github.com/teableio/docs
Teable Help
https://github.com/teableio/docs
Last synced: about 1 year ago
JSON representation
Teable Help
- Host: GitHub
- URL: https://github.com/teableio/docs
- Owner: teableio
- Created: 2023-08-10T08:36:13.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T03:09:48.000Z (about 1 year ago)
- Last Synced: 2025-04-11T03:34:41.550Z (about 1 year ago)
- Language: MDX
- Homepage: https://help.teable.io
- Size: 87.9 MB
- Stars: 8
- Watchers: 1
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Teable Help
### Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) 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](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-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`