📘
Lab Website Template docs
  • Introduction
    • Overview
    • Is this right for me?
    • Gallery
    • Support
  • Getting Started
    • Set up your site
    • Set up your URL
    • Tidy up your repo
    • Change your site
    • Preview your site
  • Basics
    • Repo structure
    • Configure your site
    • Edit pages
    • Write basic content
    • Use your logo
    • Customize your theme
    • Team members
    • Blog posts
    • Citations
    • Components
      • Section
      • Figure
      • Button
      • Icon
      • Feature
      • List
      • Citation
      • Card
      • Portrait
      • Post Excerpt
      • Alert
      • Tags
      • Float
      • Grid
      • Cols
      • Search
      • Site Search
  • Advanced
    • Update your template
    • Embeds
    • Math, diagrams, videos, etc.
    • Analytics
    • Data and collections
    • Jekyll plugins
    • Custom components
    • Background knowledge
Powered by GitBook
On this page
  1. Getting Started

Set up your URL

PreviousSet up your siteNextTidy up your repo

Last updated 1 year ago

GitHub Pages gives you for where your live site appears:

Example URL: your-custom-domain.com

Purchasing a custom domain is highly recommended. It looks professional, it's easier to remember and type, and it's easy and cheap to set up (.coms are usually only about $10 per year).

To set this up, follow the . In summary:

  1. Purchase a domain name from a reputable service.

  2. Point your domain name provider to GitHub Pages using an A record. This is slightly different for each provider; they should have their own instructions on how to do it.

  3. Set the custom domain field in your repo's "⚙️ Settings".

Example URL: your-lab.github.io

...where your-lab is your GitHub user/organization name

To set this up, rename your repo to your-lab.github.io in your repo "⚙️ Settings", and that's it!

Example URL: your-lab.github.io/your-lab-website

...where your-lab is your GitHub user/organization name, and your-lab-website is the repo name you chose.

This is where your live site appears by default when you enable GitHub Pages.

After making any needed changes above, wait a bit (~30 seconds to 3 minutes) for your live site to redeploy to its new location. (You can check your repo's "▶️ Actions" for status.)

a few options
instructions here