Gatsby Course Starter

Theme by Btholt

|

Updated: 14 Sep 2021

|

146 Stars

a gatsby starter project to help you create educational materials

Categories

Overview:

This document provides a step-by-step guide to installing a Gatsby theme for creating a course website. It includes instructions on setting up the theme, customizing the siteMetadata fields, configuring the theme variables, deploying the site to GitHub Pages using GitHub Actions, and generating CSV files for lessons and links.

Features:

• Lessons: Define lessons with frontmatter including path, order, title, and description.
• Themes: Customize the theme variables and Prism.js theme.
• GitHub Pages: Deploy the site to GitHub Pages with pathPrefix configuration.
• GitHub Actions: Easily deploy the site using GitHub Actions.
• Example Sites: View example sites created with the theme.
• CSV Generation: Automatically generate CSV files for lessons and links.

Installation:

1. Install Gatsby CLI globally: npm install --global gatsby-cli
2. Create a new Gatsby project: gatsby new course-website https://github.com/btholt/gatsby-course-starter
3. Change directory to the new project: cd course-website
4. Start the development server: npm run dev
5. Open http://localhost:8000 in your browser to view the site.
6. Customize the siteMetadata fields in gatsby-config.js.
7. Customize theme variables in variables.css file.
8. Deploy to GitHub Pages with GitHub Actions by following the provided instructions.

Summary:

This guide outlines the process of setting up and customizing a Gatsby theme for creating a course website. By following the installation instructions, users can define lessons, customize themes, and easily deploy their sites to GitHub Pages using GitHub Actions. Additionally, the theme allows for automatic generation of CSV files for lessons and links, making it a comprehensive solution for educational websites.