Git Product home page Git Product logo

gatsby-mdx-starter's Introduction

Gatsby MDX Starter

This Gatsby starter intends to be a full featured boilerplate for getting started with an MDX powered blog.

gatsby-mdx

Getting Started

  1. If you haven't already, install gatsby-cli... npm install --global gatsby-cli
  2. gatsby new my-mdx-blog https://github.com/gatsby-mdx-starter/gatsby-mdx-starter
  3. Create new blog posts as .mdx files inside of src/pages
  4. New posts should have the following frontmatter
export const frontmatter = {
  title: 'Title goes here',
  author: 'John Munson',
  draft: false,
  date: '2018-09-25T23:46:37.121Z',
  tags: ['gatsby', 'mdx', 'blog']
}
  1. gatsby develop

Todo

  • local mdx images (see issue @ gatsby-mdx)
  • index page pagination
  • keyword search
  • tag filtering
  • posts template (next, previous, title, date, etc)
  • google analytics
  • page for popular posts (powered by analytics)
  • about page
  • commenting system
  • better encapsulation of react-live css. alternatively, submit PR back to react-live so they can better support "bring your own styles"
  • update prettier to support mdx
  • make sure I'm using /static correctly
  • Setup storybook (or similar)
  • Add test suite
    • Jest
    • react-testing-library
    • cypress
    • add to the precommit routine

gatsby-mdx-starter's People

Contributors

johncmunson avatar

Watchers

James Cloos avatar

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.