Mgeeeek
95a8da31eb
Mintlify deployment failed after #5123 merged because docs/changelog/sdk.mdx contained naked `<5s` text. MDX treats `<` as a JSX tag opener, but `5` is not a valid identifier-start character, so the parser errors: "Failed to parse page content at path changelog/sdk.mdx: Unexpected character `5` (U+0035) before name, expected a character that can start a name, such as a letter, `$`, or `_`" Replace `in <5s` with `in under 5 seconds`. Other `<...>` patterns in the entry (e.g. `<name>`, `<email>`, `<their-email>`) are all inside backticks which Mintlify treats as literal code spans, so they don't trigger the JSX parser.
Mintlify Starter Kit
Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including
- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components
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 mint.json is)
mintlify dev
Publishing Changes
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
Troubleshooting
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json