gatsby-starter-mdx-blog

gatsby-starter-mdx-blog

Build your own blog w/ MDX & Gatsby

Install

$ git clone [e-mail]:wonism/gatsby-starter-mdx-blog.git <<PROJECT_NAME>>
# Recommend you to delete `.git`
$ cd <<PROJECT_NAME>> && rm -r .git

Start with gatsby-cli

$ gatsby new <<PROJECT_NAME>> https://github.com/wonism/gatsby-stater-mdx-blog

Development

$ npm start

Build

$ npm run build

Features

• ⚛️ Support writing blog contents w/ MDX
• 🔖 Support Category and Tag
  • You can just add categories: ["Category"] and tags: ["Tag"] below the date in mdx file.
• 🔢 Support pagination
• 🌙 Support dark mode
• 💬 Support Resume
  • Generate PDF with your data. (written in JSON format)
  • Download
• ✏️ Draft version of your post
  • You can just add draft: true below the date in mdx file.
• 🔮 Support comments w/ Utterances
• ✉️ Support Contacts Form w/ React Mail Form
• 🗄 Support Sitemap and RSS Feed
• 🤖 Support post scaffolding
  • You can just run npm run new then input url & title. (slugify the url automatically.)
• 📝 All codes are written in TypeScript
• 💅 CSS in JS w/ Emotion
• 🔍 Search Engine Optimization w/ React Helmet
• 📊 Google Analytics

You SHOULD change...

• Your picture in ./content/images/profile.png
• Favicon in ./content/images/favicon.png
  • You can check the details for favicon in Gatsby Plugin Manifest
• Your biography in src/shared/Bio/index.tsx
• Your Resume data in src/constants/resume.ts
  • If you do not want show resume, you can check onCreatePage in gatsby-node.js.
• gastby-config.js
  • site meta data
  • google analytics tracking id