Beacon

Deploy the documentation site

Push the changes to GitHub

Commit the changes

On your local machine, commit the page that you added, my-page.mdx, and the content/nav.config.ts file:

git add .
git commit -m "Add my page"

Connect the remote repository

Connect your local repository to the new GitHub repository. Replace <your-github-username> with your GitHub username:

git remote add origin https://github.com/<your-github-username>/my-docs.git

Push to main

Push the changes to the <your-branch> branch:

git push -u origin <your-branch>

Tip

If the push fails with Password authentication is not supported for Git operations, GitHub rejected your account password.

  • If you've added an SSH key to your GitHub account, switch the remote to SSH by running git remote set-url origin git@github.com:<your-github-username>/my-docs.git, and then push again.

  • Otherwise, when Git prompts for a password, enter a personal access token instead.

Deploy the site to Vercel

Deploy the site to Vercel to publish the new documentation.

Vercel builds the site from the GitHub repository when you push to the main branch.

Beacon picks up the files automatically and adds them to the client-side search index.

The build also adds the new pages to the sitemap.

Deploy the site

In the Vercel dashboard, click Deploy. After the first deployment, every push to main triggers a new production deployment, and pushes to other branches create preview deployments.

View the live page

Open https://<your-vercel-domain>/my-page to view the new page.

Verify the deployment

  • Load the deployed URL and confirm the sidebar, search (Cmd/Ctrl+K), and dark mode toggle work.

  • Check /sitemap.xml, /robots.txt, and /llms.txt resolve and reference the correct production domain, not example.com.

  • Open a page's Markdown version, such as /quickstart.md or /index.md for the home page, and confirm it loads as plain text.

  • If the site is served from a subpath, click through a few internal links to confirm BASE_PATH was applied consistently to both pages and static assets. This doesn't apply when you deploy the site on Vercel.

See Troubleshooting for fixes to common build and deployment issues.