@kunalja's math blog starter

Write and release your important mathematical and technical findings with this blog boilerplate. This starter is built with Gatsby, a blazing fast app generator for React.

✨ Features

• Responsive - utilizing tachyons, this site was built mobile first!

• MDX - allowing you to utilize hydrated React components in Markdown!

  Check out this interactive counter component:

  Count: 0

• Latex - with both inline and block options with the `$` key word.

  For example: $a^2 + b^2 = c^2$   becomes   $a^2 + b^2 = c^2$

• Code Syntax Highlighting - allowing you to communicate about software with specificity and clarity.

    #include <iostream>
    int main() {
        std::cout << "Hello World!";
        return 0;
    }
  

• Dynamic Configurations customizing your site's title, author, description, and social links!

Your website will change depending on the options you set in your `site.config.js`

🚀 Get Started

1. Install Gatsby.

   Install the gatsby cli via npm.

   npm install -g gatsby-cli
   

2. Create a Gatsby site.

   Use the Gatsby CLI to create a new site, specifying the blog starter.

   gatsby new math-blog-starter https://github.com/kunalja/gatsby-starter-math-blog
   

3. Start developing.

   Navigate into your new site’s directory and start it up.

   cd math-blog/
   npm run develop
   

4. See the development server live!

   Your site is now running at http://localhost:8000!

5. Configure your site.

   //site.config.js
   module.exports = {
     title: `M@th B|og`,
     description: `The premier math blog starter for Gatsby.`,
     author: `@kunalja`,
     personalDescription: `I am a student at the University of Texas.`,
   
     //Add your links to these websites or put a 0 if you don't use those sites
     //Do not add or remove any sites (unless you are willing to modify the grapql in pages/index.js)
     socialLinks: {
       facebook: 0,
       gatsby: 0,
       github: `https://github.com/kunalJa/gatsby-starter-math-blog`,
       imdb: 0,
       linkedin: `https://www.linkedin.com/in/kunalja`,
       reddit: 0,
       skype: 0,
       slack: 0,
       spotify: 0,
       telegram: 0,
       twitter: 0,
       whatsapp: 0,
     }
   }
   

6. Write new posts.

   Navigate to the blog folder and create new .mdx files for each new post you make.

   cd blog/
   # Windows cmd
   type NUL >> 2020-03-25-my-first-post.mdx
   # Unix zsh or bash
   touch 2020-03-25-my-first-post.mdx
   

   Make sure you include valid frontmatter with the fields title, date, and description.

   ---
   title: "My first post"
   date: "2020-03-25"
   description: "This post is my first and probably my last"
   ---
   
   # My first post!
   
   this is an example of a post one might make.
   

   Save your changes and the site will update in real time!

🐞 Bugs or Questions?

Please send them my way at gatsby-starter-math-blog/issues

💖 Thank you for checking this starter out