gatsby-theme-acmeblog

A simple blog for AMCE (it could be a barista) with a main page, blog and about page. All with exception of the main page are mdx. This theme is leveraging gatsby-theme-acmeblog-data that is handling all the data concerns for us. Here we are "receiving" that data, shadowing gatsby-theme-acmeblog-data and styling the different components using theme-ui.

Motivation

First of all I wanted to learn how to build gatsby themes, and there is not better way to learn than doing, secondly because I loved the idea of being able to separate data concerns with ui concerns and wanted to apply that to my projects.

This is a very simple theme that takes uses gatsby-theme-acmeblog-data to build a nice UI for a webpage for AMCE, the coolest barista in town.

Installation

with npm

npm install gatsby-theme-acmeblog

with yarn

yarn add gatsby-theme-acmeblog

Usage

Theme options

| key | default value| description | |----------|-------------|------| | blogPath | /blog | defines the url (slug) for the blog posts overview page | | postsContentPath | content/posts | location of all the posts files | | postsContentThumbnail | content/images | location of all the thumbnails images used in the posts | |pagesContentPath| content/pages| location of other pages that you would like to build using mdx| |otherImagesContentPath| images | location for any other images that you would like to post in your | |tagsPath| /tags| defines the url (slug) for all existing tags, shown in a overview tags page and used for listing all posts with a certain tag (prepending it to the tag itself, e.g. /blog/tags/yourtag) | |categoryPath|/category | defines the url (slug) used for listing all posts with a certain category (prepending it to the category itself, e.g. /blog/category/yourcategory) | |postTableOfContents|false| If you would like to have a table of contents in your posts page change it to true|

How to use theme options

In gatsby-config.js you will be able to define the options

module.exports = { 
  plugins: [
    {
      resolve: "gatsby-theme-acmeblog-data",
      options: { 
        blogPath: "/anything", // the default will be /blog
        tagsPath: "/mytags", // the default will be /tags
        categoryPath: "/mycategory", // the default will be /category
        postsContentPath: "myblog/posts", // the default will be content/posts
        pagesContentPath: "myblog/pages", // the default will be content/pages
        otherImagesContentPath: "mysuperimages", // the default will be images
        postTableOfContents: true //the default is false
      }
    },
  ],
};

How to use Mdx for your posts

Url (slug) of your posts

This will be automatically generated for you and it will be the name of the mdx file created

The frontmatter will need to have the following structure

---
title: "My firstpost"
date: "2020-05-21"
category: Mdx  
tags: 
    - post
    - mdx
    - gatsby
thumbnail:  ../images/gatsby-icon.png  
---

• title - will be the title of the blog post
• date - will be the date that will be shown in the blog post;
• category - defines the category of this post
• tags - the tags that you want this particular post to have
• thumbnail - in case you want to give the post a thumbnail

Additional configuration

In addition to the theme options the siteMetadata object is extremely useful. In our gatsby-config.js you will have the following:

siteMetadata: {
    siteTitle: `ACME`,
    siteTitleAlt: `Simple Blog - @tfs/gatsby-theme-acmeblog`,
    siteHeadline: `Simple Blog - Gatsby Theme from tiagofsanchez`,
    // siteUrl: ``,
    siteDescription: `A blogging theme with small aesthetics. Includes tags and categories support`,
    siteLanguage: `en`,
    siteImage: `./images/logo.png`,
    author: `tiagofsanchez`,
    navigation: [
      {
        title: `blog`,
        slug: `/blog`,
      },
      {
        title: `about`,
        slug: `/about`,
      },
    ],
    externalLinks: [
      {
        name: `LinkedIn`,
        url: `https://www.linkedin.com/in/tiagofsanchez/`,
      },
      {
        name: `Twitter`,
        url: `https://twitter.com/tiagofsanchez`,
      },
    ],
  },

Overall example

Example being used

module.exports = {
  siteMetadata: {
    siteTitle: `ACME`,
    siteTitleAlt: `Simple Blog - @tfs/gatsby-theme-acmeblog`,
    siteHeadline: `Simple Blog - Gatsby Theme from tiagofsanchez`,
    // siteUrl: ``,
    siteDescription: `A blogging theme with small aesthetics. Includes tags and categories support`,
    siteLanguage: `en`,
    siteImage: `./images/logo.png`,
    author: `tiagofsanchez`,
    navigation: [
      {
        title: `blog`,
        slug: `/blog`,
      },
      {
        title: `about`,
        slug: `/about`,
      },
    ],
    externalLinks: [
      {
        name: `LinkedIn`,
        url: `https://www.linkedin.com/in/tiagofsanchez/`,
      },
      {
        name: `Twitter`,
        url: `https://twitter.com/tiagofsanchez`,
      },
    ],
  },
  
  plugins: [
    `gatsby-plugin-theme-ui`,
    `gatsby-plugin-sharp`,
    `gatsby-transformer-sharp`,
    {
      resolve: "gatsby-plugin-layout", 
      options: { 
        component: require.resolve(`./src/components/layout`)
      }
    },
    {
      resolve: "gatsby-theme-acmeblog-data",
      options: { 
        postTableOfContents: true
      }
    },
  ],
};

Dev notes

There are a couple of things that I still need to do

• [ ] thumbnail is not totally implemented at gatsby-theme-acmeblog
• [ ] table of contents that highlights the zone where user is