README.md

Gatsby Theme Profile Builder

This is theme which generates site to show case your work profile and your contentful CMS blog articles directly with zero coding, required only few configuration mentioned below.

See the live demo

Installation

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

1. Install the theme

   npm install --save @ashr81/gatsby-theme-profile-builder

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

   module.exports = {
     siteMetadata: {
       title: "Gatsby Theme Starter",
       author: {
         name: 'Ashrith',
         github: 'https://www.github.com/ashr81',
         phone: '*** YOUR PHONE NUMBER ***',
         twitter: '*** YOUR TWITTER HANDLER ***',
         image_url: '*** IMAGE URL ***(200x200)'
       },
       description: 'Gatsby theme starter using contentful CMS'
     },
     plugins: [{
       resolve: "@ashr81/gatsby-theme-profile-builder",
       options: {
         contentFulCredentials: {
           spaceId: process.env.CONTENTFUL_SPACE_ID,
           accessToken: process.env.CONTENTFUL_ACCESS_TOKEN
         }
       }
     }],
   }

   siteMetadata is required to build your profile to showcase. CONTENTFUL_SPACE_ID and CONTENTFUL_ACCESS_TOKEN are the environment variables for your spaceId and access token for you contentful CMS account: You can signup for one here

3. Add in yml file with all your experience data to build profile UI using it: File should be outside src folder Example: data/timelines.yml Refer here for more details

4. Start your site

   gatsby develop

You can check demo site repository at here: https://github.com/ashr81/gatsby-demo-site/tree/master