@lekoarts/gatsby-theme-emma

Minimalistic portfolio with full-width grid, page transitions, support for additional MDX pages, and a focus on large images. Especially designers and/or photographers will love this theme! Built with MDX and Theme UI.

Read the Source Code.

Also be sure to check out other Free & Open Source Gatsby Themes and my Personal Website.

Features

• MDX
• Theme UI-based theming
• react-spring page animations
• Optional MDX pages which automatically get added to the navigation

Installation

npm install @lekoarts/gatsby-theme-emma

Install as a starter

This will generate a new site that pre-configures the theme including example content and additional plugins.

npx gatsby new gatsby-starter-portfolio-emma https://github.com/LekoArts/gatsby-starter-portfolio-emma

View the starter's code

Usage

Theme options

The usage of content/pages is optional. If no page/MDX file is found the navigation will be hidden.

Example usage

// gatsby-config.mjs
const config = {
  plugins: [
    {
      resolve: `@lekoarts/gatsby-theme-emma`,
      options: {
        // basePath defaults to `/`
        basePath: `/sideproject`,
        // projectsPath defaults to `content/projects`
        projectsPath: `content/cool-projects`,
      },
    },
  ],
};

export default config;

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.mjs

// gatsby-config.mjs
const config = {
  siteMetadata: {
    // Used for the title template on pages other than the index site
    siteTitle: `Emma`,
    // Default title of the page
    siteTitleAlt: `Emma - @lekoarts/gatsby-theme-emma`,
    // Can be used for e.g. JSONLD
    siteHeadline: `Emma - Gatsby Theme from @lekoarts`,
    // Will be used to generate absolute URLs for og:image etc.
    siteUrl: `https://emma.lekoarts.de`,
    // Used for SEO
    siteDescription: `Minimalistic portfolio with full-width grid, page transitions, support for additional MDX pages, and a focus on large images`,
    // Used for og:image and must be placed inside the `static` folder
    siteImage: `/banner.jpg`,
    // Set the default "lang" attribute on "html" element
    siteLanguage: `en`,
    // Twitter Handle
    author: `@lekoarts_de`,
  },
};

export default config;

Shadowing

Please read the guide Shadowing in Gatsby Themes to understand how to customize the theme! Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-emma/ 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 an image to the created folder (from step 1)
4. Reference this image as your cover in the frontmatter
5. Write your content below the frontmatter
6. Use defer to opt-in into Deferred Static Generation (DSG) (optional)
7. Add a slug to the frontmatter to use a custom slug, e.g. slug: "/my-slug" (Optional)

Frontmatter reference:

---
client: "LekoArts"
title: "Theme"
cover: "./image.jpg"
date: "2019-06-10"
service: "Theme"
color: "#8e9d31"
defer: false
---

Adding a new page

Additional pages will be shown in the navigation (left side) and allow you to display content other than projects, e.g. a "Contact" or "About Me" page. General setup:

1. Create a new folder inside content/pages
2. Create a new index.mdx file, and add the frontmatter
3. Add an image to the created folder (from step 1)
4. Reference this image as your cover in the frontmatter
5. Write your content below the frontmatter
6. Use defer to opt-in into Deferred Static Generation (DSG) (optional)

Frontmatter reference:

---
title: "Name"
slug: "/name"
cover: "./name.jpg"
defer: false
---

Project Info

You can shadow src/@lekoarts/gatsby-theme-emma/components/project-info.tsx to edit the three informational items below the title on the project template.

Changelog

You can find the extensive changelog of changes on GitHub. You'll be able to see each patch, minor, and major changes and what pull requests contributed to them.

Questions?

If you have general questions or need help with Gatsby, please go to one of the support platforms mentioned in Gatsby's documentation. If you have a specific question about this theme, you can head to the GitHub Discussions of the repository.

🌟 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 GitHub Sponsors!