Skip to main content
HeadKit Commerce Quickstart

​
Create your Store

Getting started is quick and easy. First you will be prompted to create your new store.
  • Enter your Store Name.
  • Confirm or change your Store URL. This is your preview subdomain, you can add a custom domain later.

​
Configure your Store

Follow the steps to hook up vital connections to HeadKit Commerce. We’ll spin up your headless store in as fast as 10 minutes.

​
1. Connect Repository

Select a Git provider to connect your code repo.

GitHub

During the onboarding process, we created a repository on your Github with your docs content. You can find this repository on our dashboard. To clone the repository locally, follow these instructions in your terminal.
More Git providers coming soon. Learn more about repositories
During the onboarding process, we created a repository on your Github with your docs content. You can find this repository on our dashboard. To clone the repository locally, follow these instructions in your terminal.
Previewing helps you make sure your changes look as intended. We built a command line interface to render these changes locally. 1. Install the Mintlify CLI to preview the documentation changes locally with this command: npm i -g mintlify 2. Run the following command at the root of your documentation (where mint.json is): mintlify dev
Our Github app automatically deploys your changes to your docs site, so you don’t need to manage deployments yourself. You can find the link to install on your dashboard. Once the bot has been successfully installed, there should be a check mark next to the commit hash of the repo.
Commit and push your changes to Git for your changes to update in your docs site. If you push and don’t see that the Github app successfully deployed your changes, you can also manually update your docs through our dashboard.

​
2. Connect Commerce

Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own. Learn more about commerce connections

​
3. Connect Payments

Stripe

During the onboarding process, we created a repository on your Github with your docs content. You can find this repository on our dashboard. To clone the repository locally, follow these instructions in your terminal.
Learn more about payments That’s all! You’re all setup and ready with a headless store running on HeadKit.

​
Next Steps

Because it was so quick and easy to go headless, you can now spend your time on making the store yours and creating an awesome user experience.

Style Your Docs

Add flair to your docs with personalized branding.

Add API Endpoints

Implement your OpenAPI spec and enable API user interaction.

Integrate Analytics

Draw insights from user interactions with your documentation.

Host on a Custom Domain

Keep your docs on your own website’s subdomain.