Giter VIP home page Giter VIP logo

fem-design-systems-docs's Introduction

gatsby-course-starter


project logo

A Gatsby starter to get you started creating educational materials using Markdown

Get Started

  1. npm install --global gatsby-cli - make sure you're on Gatsby v2+
  2. gatsby new course-website https://github.com/btholt/gatsby-course-starter
  3. cd course-website
  4. npm run dev
  5. Open http://localhost:8000 in your browser

Lessons

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 lesson
  • title - will be the title displayed on the Table of Contents and on the page itself
  • order - the order of which the item should appear in the table of contents. The first item should be of order 0. The second should be 1, etc. Must be numbered sequentially, i.e. don't skip numbers.

Config

Inside of gatsby-config.js be sure to fill out the siteMetadata fields, including title, subtitle, description, and keywords.

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.

GitHub Actions

This site is ready to deployed to GitHub Pages out of the box with GitHub Actions. If you do not want to deploy this to GitHub Pages, delete the .github directory.

If you do want to deploy this to GitHub Pages with GitHub Actions, you need to do a few things.

  1. Create a personal access token with rights to read and write to repos.
  2. Put that token in your repos secrets. Click the Settings tab and paste your access token in the Secrets tab with the key ACCESS_TOKEN.
  3. Now once you commit your code, it should automatically deploy your GitHub Pages site should deploy automatically!

Example Sites

License

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.

fem-design-systems-docs's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.