📘
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 site

PreviousSupportNextSet up your URL

Last updated 9 months ago

There are two ways to start your copy of the template from : generating or forking. They each have pros and cons:

Generate (recommended)
Fork

Pros

  • Clean commit and Actions history; a "fresh start".

  • Can have multiple per user/organization.

  • A bit easier to .

Cons

  • A bit harder to .

  • You get in your repo's commit and Actions history.

  • Can only have one per user/organization.

Once you decide which approach to take, follow the appropriate setup steps below. We've tried to automate this setup for you as much as possible, within the limitations of GitHub!

  1. with the button.

    1. Name your repo something like your-lab-website to avoid confusion with the template itself.

    2. Set the repo to "Public" visibility.

    3. Uncheck "Include all branches".

  2. In your repo's "⚙️ Settings", , and .

  3. In your repo's "▶️ Actions", find the "first time setup" workflow and . Wait for it to complete (~30 seconds).

  4. In your repo's "⚙️ Settings", the gh-pages branch. Wait for the first build of your site to complete (~3 minutes, multiple Actions workflows will run).

  5. Your repo should be initialized and your site should be live! Check your readme for the link.

  1. with the button.

    1. Name your repo something like your-lab-website to avoid confusion with the template itself.

    2. Check "Copy the main branch only".

  2. In your repo's "▶️ Actions", acknowledge the warning and enable Actions workflows.

  3. In your repo's "⚙️ Settings", , and .

  4. In your repo's "▶️ Actions", find the "first time setup" workflow and . Wait for it to complete (~30 seconds).

  5. In your repo's "⚙️ Settings", the gh-pages branch. Wait for the first build of your site to complete (~3 minutes, multiple Actions workflows will run).

  6. Your repo should be initialized and your site should be live! Check your readme for the link.

  7. If you want to , in your repo's "▶️ Actions", find the "on schedule" workflow and .

A lot of the automation in this template relies on GitHub Actions, which sometimes (very rarely) . Be aware of this in case a process in the template ever fails.

GitHub frequently changes and rearranges its web interface, so you may notice slight discrepancies in the instructions above. We've tried to write the instructions more abstractly, linking to GitHub's official documentation for more details.

GitHub
Generate a new repo from this template under your account
give GitHub Actions workflows read and write permissions
allow them to create pull requests
run it manually
set GitHub Pages to build/publish from
Fork this repo under your account
give GitHub Actions workflows read and write permissions
allow them to create pull requests
run it manually
set GitHub Pages to build/publish from
enable it
goes down
update your version of the template
update your version of the template
the development history of the template
Accidental PRs
periodic citation updates
Use this template
Fork