Support & FAQ

Have a Question? We're here to help.

We've Got You

We want to make sure that you're successful with Stackbit. Take a look at the FAQ below for answers to some common questions.

Don't see your question answered? Check the docs or contact support via email.

FAQ

How do I navigate to edit another page in Studio?

Locate the green "Edit" button from within Stackbit Studio.

edit button in Stackbit Studio

Click the button to disable edit mode and then navigate to the page by clicking links on your site. Once you are at the page you wish to edit, click "Edit" again to re-enable edit mode. Alternatively, you can append a uri variable to the URL of the Studio in your browser's address bar. For example. ?uri=/about would edit the about page while ?uri=/blog/post-4/ would edit the blog post with the slug of post-4.

How do I delete a page using Stackbit Studio?

We're working on adding the ability to directly delete pages from within the Studio editor. Until then, here are the steps to delete an existing page depending on what type of CMS you are using:

Deleting a page for sites using Git as a CMS

  1. Go to the GitHub repository for your project.

  2. Switch the branch from master to preview (for more details on why the preview branch, see this documentation page)

  3. Navigate to the page you want to remove within the site source and click the trash can icon (i.e. delete this file)

    delete a file in GitHub

  4. Commit your change.

    commit file delete into GitHub

  5. Once the change is picked up by Stackbit, the page should now be removed from your site preview within Stackbit Studio. Click the publish button when you are ready for your changes to go live.

Alternatively, if you have your project cloned locally, you can remove the page and check it in this way. Be sure that you have the preview branch checked out locally.

Deleting a page for sites using an API-based CMS (ex. Sanity, Contentful)

  1. Go to the CMS editor for your site's content (if you don't know the URL, the link should be within the settings window inside Stackbit Studio).
  2. Navigate to the page you would like to remove in the CMS and delete it.
  3. The page should now be removed from both the Stackbit Studio preview and, once your project is redeployed on Netlify, on the live site.

Can I customize the layout of my site? How?

Yes. The site is yours to customize as you wish. The best way to begin customizing is to clone your site locally. You can locate instructions on how to run your site locally in the readme.md file or via the instructions in the Studio's "Developer Tools" panel.

Developer Tools in the Stackbit Studio

How do I install and edit my project locally?

For projects that work within the Stackbit Studio, instructions for installing your project locally can be found within the Studio's "Developer Tools" panel.

Developer Tools in the Stackbit Studio

Alternatively, the instructions for running your project locally can be found in the project's readme.md file.

How do I connect my custom domain?

For users who authenticated with Github and are using Netlify, you will need to log into Netlify and add your custom domain there using these instructions. If you do not have a Github account, or just need some additional guidance, we will be glad to help you. Please contact support with your project ID, which can be found in the URL when using the Studio.

Why are my edits not showing up in the Studio preview?

In most cases, this occurs on projects using Git as a CMS and is due to changes being made to the master branch but not the preview branch. The most efficient way to solve this is to merge any changes that have been made to master into the preview branch.

git checkout preview git merge master

It is recommended that you make edits directly to the preview branch. These will be pushed to master - along with your content changes - when you click publish in the Studio.

If this fails to resolve your issue or the issue you are encountering is different from the one described above, please contact support.

I am getting an error when trying to run my project locally? It says my project is missing site-metadata.json.

Usually this error means that there's a setup error between Stackbit and an API-based CMS like Contentful or Sanity. Typically, this is the result of the Stackbit API key not being set or being incorrectly set.

To see what value is set for STACKBIT_API_KEY environment variable, run printenv STACKBIT_API_KEY from the terminal/command-line. The value should only contain letters and numbers and should not contain the curly brackets (i.e. { and }).

Another option is to run npx @stackbit/stackbit-pull, which pulls the content locally from the API-based CMS, with your Stackbit API key appended via the --stackbit-api-key= paremeter.

Once the content is properly pulled, you should be able to run your site locally without errors.

If this fails to resolve your issue or the issue you are encountering is different from the one described above, please contact support.

I'm getting a permission denied error when trying to clone my GitHub repository locally. How do I fix this?

The most frequent cause this error is that you have two-factor authentication (2FA) enabled on your GitHub account. GitHub accounts with 2FA enabled require a Personal Access Token as the password when authenticating via the terminal/command line. For more information on how to create a Personal Access Token, follow GitHub's instructions.

How do I get my current project to work with editing in the Studio?

Currently, Studio is supported on all projects created using the Stackbit Site Builder. Automated support for custom projects is coming soon. However, if you have a specific project you'd like to discuss enabling in the Studio, please contact us.

I made changes to the content model of my site and now it isn't working. What do I need to do?

Every Stackbit project requires a stackbit.yaml configuration file. This file maps out the content coming from the headless CMS to the content on the site and vice versa. In some cases, content types or properties may be added to your project that are not already mapped in the stackbit.yaml. In these cases, you'll need to update the stackbit.yaml file with content model definitions for these changes or additions. Please refer to the stackbit.yaml documentation for details on how this works.

I can't access the GitHub project for my new site. What can I do?

In some cases, Stackbit does not have or request advanced GitHub permissions. This is done for security purposes to avoid requesting intrusive permissions on user's GitHub accounts. In these cases, Stackbit will initially generate a project under a Stackbit owned GitHub account (i.e.stackbit_projects) and then initiate a transfer of the repository to your GitHub account. You should receive an email from GitHub informing you of the transfer and requesting your acceptance.

If you did not receive the email, please, first, verify that it did not get caught in spam. If you are still unable to locate the email contact support to have the transfer re-initiated.

Where can I change the email on my account?

Please contact support to request an email change while we work on adding the ability to change your email address within the account settings.

How do I log into NetlifyCMS from my site

While the Stackbit Studio will let you modify and add content, sometimes you might want to log into NetlifyCMS itself. To do so:

  1. From the Stackbit Studio "Settings" menu to go to your Netlify account.
  2. Go to the "Identity" tab and click "Enable Identy".
  3. Invite the email you wish to use and go check your email.
  4. In the email invitation you recieve, click the link. You will be prompted to create a password.
  5. In the Netlify "Identity" tab, on the left hand sde, click “Settings and Usage”.
  6. On the left hand menu under "Identity", click “Services”.
  7. Enable “Git Gateway”.
  8. Go to your live site at ".netlify.app/admin" and you’ll be able to login to your site's netlifyCMS. You can also click on the "Live Site" button in the Studio and append "/admin" to the end of URL.

How much does Stackbit cost?

We have multiple pricing plans available including a Free plan.
Current pricing and plan details can be found on our pricing page

What CMS and static site generators are supported in Studio?

We are continuing to expand support for headless CMS and static site generators in Stackbit Studio. Currently, the following options are supported:

Supported SSG:

  • Next.js
  • Gatsby
  • Hugo
  • Jekyll

Supported CMS

  • Sanity.io
  • Contentful
  • Git

My favorite static site generator is not supported. When will you be adding support for it?

We are always workng on expanding support for new tools in Stackbit and the Stackbit Studio. Our current SSG roadmap includes Hugo and Jekyll support in the Stackbit Studio. We are also exploring 11ty support in the site builder and potentially Stackbit Studio. If you have a specific project you'd like to discuss that requires SSG support we do not currently have, let us know.

My favorite CMS is not supported. When will you be adding support for it?

We are always workng on expanding support for new tools in Stackbit and the Stackbit Studio. Our current SSG roadmap includes Kentico Kontent support. We are also exploring other possible additions. If you have a specific project you'd like to discuss that requires SSG support we do not currently have, let us know.

My favorite deployment option is not supported. When will you be adding support for it?

We are always workng on expanding support for new tools in Stackbit and the Stackbit Studio. Our current deployment option roadmap includes Azure and Vercel support. We are also exploring the possibility of supporting AWS Amplify. If you have a specific project you'd like to discuss that requires SSG support we do not currently have, let us know.

Why does the Studio say "preview is x commits ahead of master"?

For users of Git a based headless CMS, such as Git, NetlifyCMS, or Foresty CMS, you will see a small notification in the bottom corner of the Stackbit Studio which will look like this:

preview is 10 commits ahead of master When your site is created with the Site Builder, it sets up this preview branch to store all the changes made through the Studio prior to publishing. This message lets you know how many changes have been saved and are ready to be deployed.

If you're working only through the Studio you should always see either preview is ahead of master or simply preview in case no edits have been made yet.

Once you publish, preview is merged into master. At this point, the preview branch will no longer be ahead of the published site and the message will update to reflect this. If you work directly against the master branch outside of the Studio, then you can get to a state where preview is x commits behind master.

If you are modifying both through the Studio and editing your repository directly, you will reach a state where you will need to sync master with preview manually. If this happens you will see this menu appear when you click the preview message in the studio:

The preview and live site are out of synch

Follow the provided link to merge master into preview on Github.

If you're making only code changes when editing the master branch, this should not cause issues, as the Studio is restricted to editing content.

Should I delete my preview branch after merging?

Short answer: No

If you are using a git based CMS (Git, NetlifyCMS, Forestry) the preview branch is a special branch that Stackbit Studio uses to store the changes you make when editing.

If you are merging manually on Github it is easy to delete the branch after merging as their workflow will suggest is it 'safe to delete' it. Please don't.

If you have deleted this branch, it is simple to to fix. All you need to do is recreate the branch from master and it should work as expected.