Skip to content

Latest commit

 

History

History
120 lines (90 loc) · 3.01 KB

README.md

File metadata and controls

120 lines (90 loc) · 3.01 KB
Raw

Nehalem Gatsby Theme

Travis (.org)

Check the Demo!

Nehalem is a Gatsby theme for blogging.

Features

Out-of-the-box:

  • Fully responsive
  • Highly optimized (Lighthouse score ~400)
  • SEO optimized (with open graph, Twitter Card, JSON-LD, RSS and sitemap)
  • Syntax highlighting
  • Search functionality
  • Multi navigations
  • Static pages
  • Fully typed with TypeScript
  • Tagging
  • Theming
  • Customizable

See here for details!

Installation

See this repo for a quick start!

A more detailed guide on installation can be found here!

To use this theme in your Gatsby sites, follow these instructions:

  1. Install the theme

    npm install --save @nehalist/gatsby-theme-nehalem
# or
yarn add @nehalist/gatsby-theme-nehalem

  2. Add the theme to your gatsby-config.js:

    module.exports = {
  plugins: [{
    resolve: `@nehalist/gatsby-theme-nehalem`,
    options: { // optional theme options
    // location to our content
    contentPath: `content`,
    // the page manifest
    manifest: {
      name: `nehalem - A Gatsby theme`,
      short_name: `nehalem`,
      start_url: `/`,
      background_color: `#a4cbb8`,
      theme_color: `#a4cbb8`,
      display: `minimal-ui`,
      icon: `${__dirname}/assets/nehalist-gatsby.png`
    },
    // if archive pages should be generated automatically
    loadDefaultPages: true,
    // posts shown on the front page
    postsPerPage: 5
    }
  }]
}

Before starting your site make sure that the following requirements are fulfilled:

  1. Be sure to have a content directory within your Gatsby installation

  2. Be sure to have a tags.yml file within the content directory with at least one tag, e.g.

    - name: Uncategorized
  color: #000
  icon: null
  featured: false

  3. Be sure for your markdown files to include proper frontmatter content, e.g.:

---
title: "Post title"
path: "/path-to-your-post"
tags: ["Theme"]
featuredImage: "./cover.jpg"
excerpt: Descriptive description.
created: 2019-07-29
updated: 2019-07-29
---

Finally you can start your site with

gatsby develop

Documentation

The entire documentation can be found on the Demo. Alternatively check the GitHub repository.

Like the theme?

Happy to hear that! Feel free to star it on GitHub!

Author

Developed by nehalist.io.

Big thanks to my SO for the awesome logo!