Skip to content
Branch: master
Find file History
LekoArts chore(release): Publish
 - emilia@0.0.6
 - @lekoarts/gatsby-theme-emilia-core@1.0.3
 - @lekoarts/gatsby-theme-emilia@1.0.5
Latest commit 796180c Sep 10, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src fix(gatsby-theme-emilia): Make avatar configurable (#78) Sep 10, 2019
.npmignore feat(gatsby-theme-emilia): Convert Emilia starter to theme (#69) Sep 8, 2019
CHANGELOG.md chore(release): Publish Sep 10, 2019
README.md fix(gatsby-theme-emilia): Make avatar configurable (#78) Sep 10, 2019
gatsby-config.js fix(gatsby-theme-emilia): Make avatar configurable (#78) Sep 10, 2019
gatsby-node.js
index.js feat(gatsby-theme-emilia): Convert Emilia starter to theme (#69) Sep 8, 2019
package.json chore(release): Publish Sep 10, 2019

README.md

Gatsby Theme

@lekoarts/gatsby-theme-emilia

@lekoarts/gatsby-theme-emilia is released under the MIT license. Current npm package version. Downloads per month on npm. Total downloads on npm. PRs welcome! Follow @lekoarts_de

Minimalistic portfolio/photography site with masonry grid, page transitions and big images. Themeable with Theme UI. Includes Light/Dark mode.

Demo Website (Source Code)

Also be sure to checkout other Free & Open Source Gatsby Themes

Features

  • MDX
  • Theme UI-based theming
  • react-spring page animations
  • Light Mode / Dark Mode
  • Masonry grid

Installation

npm install @lekoarts/gatsby-theme-emilia

Install as a starter

This will generate a new site that pre-configures use of the theme.

gatsby new emilia LekoArts/gatsby-starter-portfolio-emilia

View the starter's code

Usage

Theme options

Key Default Value Description
basePath / Root url for the theme
projectsPath content/projects Location of projects
assetsPath content/assets Location of assets (such as the avatar in the header)
mdx true Configure gatsby-plugin-mdx (if your website already is using the plugin pass false to turn this off)
name LekoArts The name displayed as the title on the homepage, and the link to the homepage (top left corner)
location Germany Shown below the title
socialMedia [{ title: `Twitter`, href: `https://twitter.com/lekoarts_de` }, { title: `Instagram`, href: `https://www.instagram.com/lekoarts.de/` }] An array of objects (with the keys "title" and "href" display on the homepage. Can of course hold any kind of links (not limited to social media)
showThemeAuthor true Show the "Theme by LekoArts" in the footer

Example usage

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: `@lekoarts/gatsby-theme-emilia`,
      options: {
          name: `Emilia`,
          socialMedia: [
            {
              title: `Instagram`,
              href: `https://www.instagram.com/lekoarts.de`
            }
          ]
        }
      }
    }
  ]
};

Additional configuration

In addition to the theme options, there are a handful of items you can customize via the siteMetadata object in your site's gatsby-config.js

// gatsby-config.js
module.exports = {
  siteMetadata: {
    // Used for the title template on pages other than the index site
    siteTitle: `Emilia`,
    // Default title of the page
    siteTitleAlt: `Emilia - @lekoarts/gatsby-theme-emilia`,
    // Can be used for e.g. JSONLD
    siteHeadline: `Emilia - Gatsby Theme from @lekoarts`,
    // Will be used to generate absolute URLs for og:image etc.
    siteUrl: `https://emilia.lekoarts.de`,
    // Used for SEO
    siteDescription: `Minimalistic portfolio/photography site with masonry grid, page transitions and big images. Themeable with Theme UI. Includes Light/Dark mode.`,
    // Will be set on the <html /> tag
    siteLanguage: `en`,
    // Used for og:image and must be placed inside the `static` folder
    siteImage: `/banner.jpg`,
    // Twitter Handle
    author: `@lekoarts_de`
  }
};

Shadowing

Please read the guide Shadowing in Gatsby Themes to understand how to customize the this theme! Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-emilia/ to shadow/override files. The Theme UI config can be configured by shadowing its files in src/gatsby-plugin-theme-ui/.

Adding content

Adding a new project

New projects will be shown on the index page of this theme and can be added by creating MDX files inside content/projects. General setup:

  1. Create a new folder inside content/projects
  2. Create a new index.mdx file, and add the frontmatter
  3. Add images to the created folder (from step 1)
  4. Reference your desired images as your cover in the frontmatter
  5. Write your content below the frontmatter (optional)

Frontmatter reference:

---
cover: "./sean-foley-0JD7kvxAq0Y-unsplash.jpg"
date: "2019-09-10"
title: "Emilia"
areas:
  - Neon
  - Lights
---

The frontmatter alone is enough, if you'd like to add additional content you can do so by writing your content (as usual with MDX) below the frontmatter. It'll be displayed in the header of the project below the date and areas.

Changing the "About Me" text

Create a file at src/@lekoarts/gatsby-theme-emilia/texts/about-me.mdx to edit the text.

Changing the avatar

Place an image with the name avatar inside the folder content/assets (or your custom assetsPath which you defined for the theme).

🌟 Supporting me

Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on Twitter and share the project with me.

Please star this project, share it on Social Media or consider supporting me on Patreon!

If you want to hire me for contract/freelance work, you can do so! Get in touch with me!

You can’t perform that action at this time.