Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 4.78 KB

README.md

File metadata and controls

93 lines (73 loc) · 4.78 KB
Raw

Plain Vanilla GitHub Pages README

The purpose of this project is to make as easy as possible for less-technical people to create and host basic web pages for free on GitHub Pages.

Check out my YouTube video on how to get started using this template

Getting started

Copying the template and setting up publishing

  1. Press the Use this template button on the Code tab.
  2. Go to the Settings tab and then go to the Pages settings.
  3. Set the Source to main and press Save.

You'll see a URL show up, but the site takes a few minutes before it's actually live. In the meantime, try creating a page.

Creating your first page

  1. Go to the Code tab.
  2. Press the Add File button and select Create new file.
  3. Name the page, for example, first-page.md. (Note the lack of spaces and the inclusion of the .md extension.)
  4. Add a title in the front matter: 
    ---
title: First Page
---
  5. Add some content using markdown syntax. For example, you could start with a heading and paragraph like this: 
    # First page
This is my first page.
  6. Scroll down to the bottom of the page and press Commit new file.

Checking your page online

  1. On the Code tab, find and press the Environments link. (It may be in the right column.)
  2. On the next page (Deployments), press the View deployment button. (You should see the default homepage load.)
  3. In the address bar of the browser, add the name of your page using the HTML extension and press return. For example: first-page.html. (The full address will be something like this: https://pglevy.github.io/plain-vanilla-gh-pages/first-page.html)

You should see the new page you created.

Next steps

Now that you know how to create pages, here are some other things you can do:

  • Create more pages.
  • Update index.md (the homepage) with your own content.
  • Add links between pages so it works like a website.
  • Copy component code snippets from the GitHub Primer design system to add more advanced functionality to your pages.
  • Customize your site language, title, and description in the metadata.yml file located in the _data folder.

Default body and main styling classes

  • By default, the body element includes the p-3 utility class from Primer. This adds some padding to the page on all sides.
  • The main element includes these two classes: container-md and markdown-body. The first one sets a maximum width for the content area and the second provides the default GitHub styling for Markdown content.
  • To override these, add these settings to the front matter of your content page: body-style and main-style.

For example:

title: Home
body-style: p-0
main-style: container-lg

If you want to replace the defaults with nothing, do this:

title: My Page
body-style: ""
main-style: ""

GitHub Primer CSS framework

This projects uses a local copy of the Primer CSS to enable work locally and/or offline. Note this copy may not be the latest version because it needs to be kept up-to-date manually. Alternatively, you can use the hosted version, which always references the current version.

To switch to hosted CSS, replace this line in _layouts/default.html:

<link rel="stylesheet" href="assets/css/primer.css">

with this:

<link rel="stylesheet" href="https://unpkg.com/@primer/css/dist/primer.css">

Work with site preview using the GitHub Codespaces remote dev environment

This project is configured to work with Codespaces. This allows you work on variations of the site in a remote dev environment in your browser so you can try things out without publishing directly to the live, main branch.

To use this option, select Open in a codespace from the Use this template menu button.

For more information, see the GitHub documentation.

What to do if you're having problems

Credit and license

This project was created using the GitHub Pages gem for Jekyll. It is licensed under The Unlicense, which allows everything and promises nothing. 😎

Favicon is Soft Ice Cream from Twemoji, licensed under CC-BY 4.0.