A Gatsby starter to get you started creating educational materials using Markdown
npm install --global gatsby-cli
- make sure you're on Gatsby v2+- See docs here if you need help
gatsby new course-website https://github.com/btholt/gatsby-course-starter
cd course-website
npm run dev
- Open http://localhost:8000 in your browser
The crux of this site is are the lessons. Provided are two examples. Each lesson needs a frontmattter path
, order
, and title
. Generally you should make the path
and the file name match for ease of finding it.
path
- needs a leading slash. This will be slug of the lessontitle
- will be the title displayed on the Table of Contents and on the page itselforder
- the order of which the item should appear in the table of contents. The first item should be of order0
. The second should be1
, etc. Must be numbered sequentially, i.e. don't skip numbers.
Inside of gatsby-config.js
be sure to fill out the siteMetadata
fields, including title
, subtitle
, description
, and keywords
.
Azure has a free-for-open-source continuous integration platform called Azure Pipelines. This project is already set up for it with the azure-pipelines.yml
. Just add the project to Pipelines and it'll immediately correctly build the project. From there you'll have a build artifact that you can use to deploy to Azure Static Sites or GitHub Pages.
If you do want to deploy to GitHub pages, make sure you add the name of the repo to the pathPrefix
property in gatsby-config.js
so that it will correctly make all the links.
- Complete Intro to Web Dev v2
- Complete Intro to React v4
- Four Semesters of Computer Science in Five Hours Part II
The code is this repo is licensed under the Apache 2.0 license.
I include the CC-BY-NC-4.0 license for the content; this is what I recommend you license your content under: anyone can use and share the content but they cannot sell it; only you can.