Gatsby Simple Blog Save

an easily configurable gatsby-starter-blog with overreacted looking and tags, breadcrumbs, disqus, i18n, eslint, algolia supported

Project README

gatsby-simple-blog

Build Status CircleCI Netlify Status

Description

A gatsbyjs starter forked from gatsby-starter-blog and applied overreacted lookings, with tags and Algolia, pagination, breadcrumbs, eslint, relative posts, disqus, i18n, eslint supported.

This project is migrated to Gatsby@v4

  • check the latest Gatsby@v3 version here.
  • check the latest Gatsby@v2 version here.

Sample pages

Github-Pages

Netlify

Gatsby Cloud

How to use

npm install -g gatsby-cli

gatsby new my-blog-folder https://github.com/thundermiracle/gatsby-simple-blog

How to deploy by Circle-CI in Medium.com

Medium.com -- Deploy Static Sites to Netlify by Circle-CI

How to add search function to a multilingual GatsbyJS site with Algolia

https://thundermiracle.medium.com/how-to-add-search-function-to-a-multilingual-gatsbyjs-site-with-algolia-4ef17af888f3

Configuration

  1. Almost all basic configurable values are here: ./config/index.js

  2. To enable Algolia, create a site in Algolia and copy .env.sample to .env, change all variables to real Algolia ones. You can check the tutorial here:

https://www.gatsbyjs.com/docs/adding-search-with-algolia/#configuring-the-algolia-plugin

i18n

  1. Add [lang].js to config/locales folder

  2. Modify supportedLanguages in config/index.js

  3. Set site.lang in config/index.js as default language

  4. add [filename].[lang].md to content/blog and enjoy!

Features

  • i18n

    Display multiple language. (Only be shown when supportedLanguages > 1)

    i18n

    Display language link in every post. (You can disable it in config/index.js by displayTranslations: false)

    translations

  • overreacted design

    overreacted.io lookings

    top--light

    top--dark

  • Tags

    Display articles in same tag.

    tag

    alltags

  • Algolia

    Search posts in same language by Algolia.

    Algolia-search

  • Breadcrumbs

    Display breadcrumbs in header part.

    post

  • Relative posts

    Display previous and next posts in same tag in footer part.

    relative-posts

  • Disqus

    Use disqus.com to enable comment.

    disqus

  • eslint

    Enable eslint for better coding experience.

  • module resolver

    Enable babel-module-resolver to prevent relative path hell

License

This project is licensed under the terms of the MIT license.

Open Source Agenda is not affiliated with "Gatsby Simple Blog" Project. README Source: thundermiracle/gatsby-simple-blog

Open Source Agenda Badge

Open Source Agenda Rating