Skip to main content

Getting Started with PreTeXt

Section Part 2. Create Your Repository from the PreTeXt Template

The PreTeXt team maintains a template repository: a starter project that has all the right configuration baked in. You’ll copy it into your own account. Think of it as cloning a well-furnished apartment rather than building one from bare walls.
  1. Make sure you are signed in to GitHub in your browser. Then go to:
  2. Near the top right of that page, find the green button labeled Use this template and click it.
    The green "Use this template" button on GitHub.
    From the dropdown, choose Create a new repository.
  3. On the next page, fill in:
    • Repository name: pick something short and descriptive, for example my-first-pretext.
    • Description: optional, a sentence or two for your future self.
    • Public or Private: public is recommended if you’d ever like help from the PreTeXt community, and it doesn’t prevent you from keeping draft material unlisted. Private is fine too and easy to flip later.
  4. Click Create repository from template. After a short pause, you’ll land on your brand-new repository page, which is now a fresh copy of the template under your own account.

βœ“ You know it worked when….

The URL in your browser is github.com/YOUR-USERNAME/YOUR-REPO-NAME, and the file list shows a README.md and a .devcontainer folder.

If you get stuck: Use this template button is missing.

The most common cause is that you aren’t signed in. Look at the top right of the page: if you see Sign in, click it, log in, and refresh the template page. If the button still won’t appear, confirm your email (Part 1, step 3) and try again.