/gatsby-starter-egghead-blog

This is an example Gatsby blog site that we use as a reference at egghead.

Primary LanguageJavaScriptMIT LicenseMIT

egghead.io creator MDX Blog Starter Project

This is based on Robin Wieruch's https://github.com/rwieruch/gatsby-mdx-blog-starter-project

Lots of nice pieces are also borrowed from Jason Lengstorf https://github.com/jlengstorf/lengstorf.com

A starter project in Gatsby.js with MDX.

Deploy to Netlify

Features

  • MDX: JavaScript/React in Markdown
  • Prism.js: Syntax Highlighting
  • Pagination
  • Emotion
  • Typography.js
  • Self-hosted fonts (Inter UI)
  • Social media share buttons
  • Site & Theme config files
  • ConvertKit subscribe form (Formik and Yup)
  • Placeholder illustrations by Katerina Limpitsouni from undraw.co

➞ Demo

Setup

  • git clone git@github.com:eggheadio/gatsby-starter-egghead-blog.git
  • cd gatsby-starter-egghead-blog
  • yarn
  • gatsby develop
  • visit http://localhost:8000

Setup via Gatsby CLI

  • gatsby new gatsby-starter-egghead-blog git@github.com:eggheadio/gatsby-starter-egghead-blog.git
  • cd gatsby-starter-egghead-blog
  • yarn
  • gatsby develop
  • visit http://localhost:8000

Set up Redirects

This starter supports a redirects property on posts so that you can define alias urls for blog posts. This won't work out of the box. We use the createRedirect Gatsby actions (docs) which requires an additional plugin to be added to your site, given what provider you deploy your site to. Two popular ones are gatsby-plugin-netlify or gatsby-plugin-s3.