Skip to main content

​
Get started in three steps

Get your Vodex.ai documentation site running locally and make your first customization.

​
Step 1: Set up your local environment

During the onboarding process, you created a GitHub repository with your docs content if you didn’t already have one. You can find a link to this repository in your dashboard.To clone the repository locally so that you can make and preview changes to your docs, follow the Cloning a repository guide in the GitHub docs.
  1. Install the Vodex.ai CLI: npm i -g mint
  2. Navigate to your docs directory and run: mint dev
  3. Open http://localhost:3000 to see your docs live!
Your preview updates automatically as you edit files with Vodex.ai’s real-time preview system.

​
Step 2: Deploy your changes

Install the Vodex.ai GitHub app from your dashboard.Our GitHub app automatically deploys your changes to your docs site, so you don’t need to manage deployments yourself.
For a first change, let’s update the name and colors of your docs site to match your brand.
  1. Open docs.json in your editor.
  2. Change the "name" field to your project name.
  3. Update the "colors" to match your brand using Vodex.ai’s flexible theming system.
  4. Save and see your changes instantly at http://localhost:3000.
Try changing the primary color to see an immediate difference with Vodex.ai’s instant preview!

​
Step 3: Go live

  1. Commit and push your changes.
  2. Your docs will update and be live in moments with Vodex.ai’s automatic deployment!

​
Next steps

Now that you have your docs running, explore these key Vodex.ai features:

Write Content

Learn MDX syntax and start writing your documentation with Vodex.ai’s enhanced markdown support.

Customize style

Make your docs match your brand perfectly using Vodex.ai’s flexible theming options.

Add code examples

Include syntax-highlighted code blocks with Vodex.ai’s advanced code highlighting.

API documentation

Auto-generate API docs from OpenAPI specs with Vodex.ai’s powerful API tools.
Need help? See our full documentation or join our community.
⌘I