Index

Installation

1 minute read

Installation

Using yarn:

Or using npm:

Configuration

Add plugin to you gatsby config:

gatsby-config.js

Plugin accepts 2 options:

  • paginationOffset (number) - number of articles per page
  • author (string) - author name for the rss feed

I recommend populating also siteMetadata with those properties:

Setting up

Copy your picture into scr/img/author.png.

Now you can create mdx posts inside src directory. Every post needs to have this metadata:

  • url - Post url
  • date - Post date
  • title - Post title
  • banner - Post banner image. To disable image set this to null.
  • draft - If post should be in draft mode.

Dev environment

You can use @components and @styles aliases to import components.

You can separatelly shadow every single mdx component. Take a look inside src/components/mdx folder.

Features

License

MIT