Skip to main content

Getting Started with PreTeXt

Section Troubleshooting Quick Reference

These are the issues that come up most often. Each has already been mentioned in the relevant part of the tutorial; theyโ€™re collected here for easy lookup.

The Use this template button is missing.

You arenโ€™t signed in to GitHub, or havenโ€™t confirmed your email address. Sign in or confirm and refresh the page.

The Codespace looks frozen during first-time setup.

First-time setup takes 5 to 10 minutes. Give it fifteen before worrying. If it still hasnโ€™t loaded, close the tab and reopen the Codespace from your repositoryโ€™s < > Code โ†’ Codespaces menu.

pretext new isnโ€™t in the command palette.

The PreTeXt extension may still be initializing. Wait a minute and retry. If it still isnโ€™t there, close and reopen the Codespace.

Build fails with a red error.

Almost always a missing or mismatched tag. Check the line number in the error message. Confirm every <tag> has a matching </tag>.

Preview is blank or stale.

Build again, then refresh the preview tab with F5. If that fails, close the preview tab and reopen via โ–ท PreTeXt โ†’ View Full Document.

My Codespace disappeared.

Inactive Codespaces are recycled after about a month. Your files are safe on github.com as long as youโ€™ve committed and synced. Create a fresh Codespace from the same repository to pick up where you left off.

Deploy URL shows a 404.

Wait 2 to 3 minutes for the first deploy to finish on GitHubโ€™s side. If it still 404s, check Settings โ†’ Pages on your repository and confirm the source is set to GitHub Actions.

Deploy fails with a permissions error.

On your repository, go to Settings โ†’ Actions โ†’ General โ†’ Workflow permissions and select Read and write permissions. Save, then run Deploy again.

Something else is wrong.

The PreTeXt community forums and Discord server (see the Information & Links chapter of this hub) are genuinely helpful for unusual problems. Post a short description of what you were trying to do, what happened instead, and any error text. Someone has almost certainly hit the same thing before.