Elemental
Created on
01 Dec 2019
Updated on
20 Jan 2021
Elemental is a highly customizable gatsby theme/starter suitable for portfolio sites.
It provides the option to add blog posts, portfolio posts, and custom pages.
Starter
Getting Started.
You will need node and Gatsby installed.
Start the project by
gatsby new project-name https://github.com/akzhy/gatsby-starter-elemental
cd project-name
gatsby develop
And for the final build
gatsby build
Configuring
Almost all features of this starter are editable. In order to personalize, open the gatsby-config.js
file and start editing the below part.
// Do not remove any of the properties below.
let siteMetadata = {
title: `Elemental`, // Title of your webpage
capitalizeTitleOnHome: true, // Whether to capitalize the letter on homepage
logo: `/images/logo.png`, // Logo
icon: `/images/icon.png`, // Favicon, shown in the browsers "tab"
titleImage: `/images/wall.jpg`, // The main title is filled with an image.
introTag: `PHOTOGRAPHER | VIDEOGRAPHER`, // Intro tag shown below title
description: `Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed sit amet accumsan arcu. Proin ac consequat arcu.`,
author: `@_akzhy`,
blogItemsPerPage: 10,
portfolioItemsPerPage: 10,
darkmode: true, // Whether to enable the darkmode. Change to false if you want the light mode
switchTheme: true, // Whether to show a switch theme button on the navbar
// The links shown on the navbar and footer, follow the same structure to add or remove more items.
navLinks: [{
name: "HOME",
url: "/"
},
{
name: "ABOUT",
url: "/about"
},
{
name: "BLOG",
url: "/blog"
},
{
name: "PORTFOLIO",
url: "/portfolio"
},
{
name: "CONTACT",
url: "/contact"
}
],
// Same as navbar links, except these are shown on the footer
footerLinks: [{
name: "PRIVACY POLICY",
url: "/privacy-policy"
}],
// Your social profile links. The icons of the given social medias are available in the static folder. If you are adding a new item, include the icon in the static/images folder.
social: [{
name: "Facebook",
icon: "/images/Facebook.svg",
url: "#"
},
{
name: "Twitter",
icon: "/images/Twitter.svg",
url: "#"
},
{
name: "Instagram",
icon: "/images/Instagram.svg",
url: "#"
},
{
name: "Youtube",
icon: "/images/Youtube.svg",
url: "#"
}
],
contact: {
/* Leave this completely empty (no space either) if you don't want a contact form. */
api_url: "./test.json",
description: `Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed sit amet accumsan arcu. Proin ac consequat arcu.`,
mail: "hi@akzhy.com",
phone: "000-000-0000",
address: "1234 \nLocation \nLocation"
}
}
Creating new blog posts.
Open the contents/blog
folder and create a new folder with the name you wish to see as the URL. Inside the folder create an index.md
file and also include any files you wish to add.
The frontmatter should be of the below structure
---
title: Title of your post
date: 2019-06-29 <-- Date should be in the given format
template: blog <-- The template you wish to use. "blog" for blog posts
image: ./image.jpg <-- Image shown on the list pages and also used as open graph image
banner: ./banner.jpg <-- Banner shown in the blog post
description: The description shown in the listing page. Also used for SEO description.
---
If you don’t want the blog section, simply delete everything inside the contents/blog
folder. (Do not delete the folder itself)
Creating new portfolio posts.
Open the contents/portfolio
folder and create a new folder with the name you wish to see as the URL. Inside the folder create an index.md
file and also include any files you wish to add.
The frontmatter should be of the below structure
---
title: Title of your post
date: 2019-06-29 <-- Date should be in the given format
template: blog <-- The template you wish to use. "blog" for blog posts
image: ./image.jpg <-- Image shown on the list pages and also used as open graph image
description: The description shown in the listing page. Also used for SEO description.
---
Portfolio pages support the creation of grids.
To create a grid, follow the below structure
[row]
[col]
**Markdown**
[/col]
[/row]
The columns will have equal width on wide screens, and will expand on smaller screens.
Creating Pages
To create a page, create a markdown inside contents/basepages
. Follow the structure of about.md
or privacy-policy.md
.
Theme
Installation
To use this theme follow these instructions:
- Install the theme
npm install gatsby-theme-elemental
- Add the theme to your
gatsby-config.js
module.exports = {
plugins: [
'gatsby-theme-elemental'
]
}
- Develop
gatsby develop
or build
gatsby build
Other theme options are same as the starter explained above.
Comments
Post a comment
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.