❤
npm
Sign UpSign In

gatsby-theme-styled-mdx

1.0.0 • Public • Published

Gatsby Theme Styled MDX

A template to easily create landing pages or a blog using the GatsbyJS framework to generate a static React powered PWA. It's lightning fast, SEO friendly, and deploys directly to a CDN like Github Pages or Netlify.

You create content your using MDX, a mix of Markdown and JSX, allowing you to import and use React components inside of your Markdown (and much more). And you can create those React components inside Storybook, an isolated development environment for coding more accessible components.

🔎 Check out the how-to-use MDX file to see MDX in action!

Features

  • 🎛 MDX
  • 🔏 Typescript
  • 💄 Styled Components
  • 📦 Styled System
  • ⚙️ Rebass
  • ☎️ SEO component
  • 🐦 Twitter embeds
  • 📱 PWA
  • ✈️ Offline-ready
  • 📇 RSS
  • 📝 Setup for blogs
  • 📡 Webpack aliasing
  • 👕 Prettier + ESLint + Markdown Lint
  • 🔌 Nodemon

Getting Started

  1. Clone the example repo: git clone git@github.com:whoisryosuke/gatsby-theme-styled-mdx-example.git
  2. Install any dependencies: yarn
  3. Run the development server: yarn develop
  4. Your site should be running at: http://localhost:8000

Manual Setup

  1. Create a new Gatsby project: npx gatsby new myproject
  2. Install the theme as a dependency: yarn add gatsby-theme-styled-mdx
  3. Add the theme and necessary filesystem configurations to gatsby-config.js:
module.exports = {
  plugins: [
    {
      resolve: `gatsby-source-filesystem`,
      options: {
        name: `content`,
        path: `${__dirname}/content/`,
      },
    },
    {
      resolve: `gatsby-source-filesystem`,
      options: {
        name: `content`,
        path: `${__dirname}/src/pages/`,
      },
    },
    { resolve: `gatsby-theme-styled-mdx`, options: {} },
  ],
}
  1. Create directories that will hold your blog and page content. By default (see above filesystem paths), the theme is configured to grab MDX files from a /content/ folder located in your project root. You can also store content in subfolders to organize it, Gatsby will search the content folder recursively.
📦
├── 📂 content
    ├── 📂 blog
        └── 📄 sample-blog.mdx
    ├── 📄 another-blog-post.mdx
    └── 📄 sample-page.mdx
├── 📂 node_modules
├── 📂 src
├── 📄 .gitignore
├── 📄 package.json
  1. Create a test MDX file in the /content/ directory you just made (see Post Format)
  2. Start the development server: gatsby develop

Configure SEO plugins

This theme comes pre-installed with SEO plugins for a site manifest, sitemap, and integrating Google Analytics.

Add the following to the plugins array of your gatsby-config.js and customize any values necessary:

{
  resolve: `gatsby-plugin-manifest`,
  options: {
    name: 'Your Website Name',
    short_name: 'YourSite',
    start_url: '/',
    background_color: '#F5F5F5',
    theme_color: '#005CDD',
    display: 'minimal-ui',
    icon: `${__dirname}/static/assets/favicon/android-chrome-512x512.png`, // This path is relative to the root of the site.
    // icons: [
    //   {
    //     // Everything in /static will be copied to an equivalent
    //     // directory in /public during development and build, so
    //     // assuming your favicons are in /static/favicons,
    //     // you can reference them here
    //     src: `/assets/favicons/android-chrome-192x192.png`,
    //     sizes: `192x192`,
    //     type: `image/png`,
    //   },
    //   {
    //     src: `/assets/favicons/android-chrome-512x512.png`,
    //     sizes: `512x512`,
    //     type: `image/png`,
    //   },
    // ],
  },
},
{
  resolve: `gatsby-plugin-sitemap`,
  options: {
    // output: `/some-other-sitemap.xml`,
    // exclude: [`/path/to/page`, `/another/page`],
    query: `
    {
      site {
        siteMetadata {
          siteUrl
        }
      }
 
      allSitePage {
        edges {
          node {
            path
          }
        }
      }
  }`,
  },
},
{
  resolve: `gatsby-plugin-google-analytics`,
  options: {
    trackingId: '420',
    // Puts tracking script in the head instead of the body
    head: false,
    // Setting this parameter is optional
    anonymize: true,
    // Setting this parameter is also optional
    respectDNT: true,
  },
},

For more information about each plugin and it's API, check out their Github or Gatsby documentation.

Theme Structure

Post Format / Fields

---
title: Deploy a Static React Blog using GatsbyJS and Github
date: '2018-03-21'
section: blog
cover_image: './bulma-css-framework@1x.jpg'
tags:
  [
    'design',
    'development',
    'react',
    'github',
    'gatsbyjs',
    'ssg',
    'static site generator',
  ]
---
 
Your post here
  • Section can be blog or page.
  • Tags must be array
  • Date must be in 'YYYY-MM-DD' format. If you forget to add a zero (e.g. 2019-4-20 instead of 2019-04-20) GraphQL will crash.
  • Body content can include Markdown, HTML, or JSX.

You can also use custom components in your body content, like Rebass components. You can find all these components here to reference or override: gatsby-theme-styled-mdx/src/layouts/Theme.jsx

Plugins

Twitter

Seamlessly embed Tweets into posts by copying the blockquote portion of the embed code to your Markdown file. Don't copy the linked JS file, the plugin handles that automatically.

Manifest

Configure in gatsby-config.js.

RSS Feed

Configure in gatsby-config.js.

Development

This is a Gatsby theme, which works as a dependency installed on another Gatsby site. This means you have to work in an environment that supports editing relative node modules, like Yarn Workspaces. To expedite development, there is a "workspace" repo that you can clone to replicate this environment easily.

  1. Clone the workspace repo: git clone git@github.com:whoisryosuke/gatsby-theme-styled-mdx-workspace.git
  2. Clone the example repo (inside workspace folder): git clone git@github.com:whoisryosuke/gatsby-theme-styled-mdx-example.git
  3. Clone the theme (inside workspace folder): git clone git@github.com:whoisryosuke/gatsby-theme-styled-mdx.git
  4. Install all dependencies by running yarn in the workspace root.
  5. Start the development server (in workspace root): yarn develop

Check out the Gatsby guide on themes for more information on the architecture and how to work with themes

Deployment

Github Pages

We locally build the files, then deploy using an NPM script that updates a specific Git repo branch called gh-pages.

To enable this, just initialize a git repo in the project, commit your changes, and add your Github repo as a remote repo. Make sure to label the remote as origin, otherwise the Gatsby deploy won't know which repo to push to.

Deploy site to origin remote repo:

npm run deploy

Creating or editing content

  1. git pull from remote origin to ensure you have the latest posts and to merge any conflicts.
  2. Add a new folder to content/pages or content/blog named after your post. This will be converted to the slug of the article -- you don't need to 'kebab-case' your title, but keep the format in mind.
  3. Create a MDX file in the folder. Make sure to use previous files as a template to include all the appropriate frontmatter fields (listed above).
  4. Fill out the post, optionally add a cover image (see next step for handling images)
  5. For any images, include them in the same folder as the post's Markdown and link locally using <img src="./my-image.jpg" />. Or add them to the /static/assets/ folder and it'll be accessible at http://yourwebsite-or-localhost.com/assets/your-img.jpg.
  6. Run npm run deploy in the project root to deploy to Github Pages. Or commit code to Github's master branch to trigger a Netlify deploy.

Netlify

This site is also capable of deploying on Netlify. Simply login to Netlify, create a new app, and point to this repository. Follow the steps, make sure Netlify is running gatsby build and pointing to the /public directory. This also allows you to use the Netlify CMS, since it requires a server for OAuth2 support and hosting on Netlify allows you re-build on each edit (rather than building from you personal machine and deploying from there).

References

Credits

Readme

Keywords

Package Sidebar

Install

npm i gatsby-theme-styled-mdx

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

547 kB

Total Files

112

Last publish

Collaborators

  • whoisryosuke
Try on RunKit
Report malware