lekoarts / gatsby-starter-portfolio-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.

Gatsby Starter Portfolio: Emma

Minimalistic portfolio with full-width grid, page transitions, support for additional MDX pages, and a focus on large images. Using the Gatsby Theme @lekoarts/gatsby-theme-emma.

Demo Website

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

✨ Features

• MDX
• react-spring page animations
• Optional MDX pages which automatically get added to the navigation
• Fully customizable through the usage of Gatsby Themes (and Theme UI)
• Light Mode / Dark Mode
• SEO (Sitemap, OpenGraph tags, Twitter tags)
• WebApp Manifest

⏱️ Quick Start

Deploy this starter with one click on Netlify:

🚀 Getting Started

1. Create a Gatsby site.

Use the Gatsby CLI to clone the site and install dependencies:

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

2. Navigate to your new project.

cd gatsby-starter-portfolio-emma

3. Open the code and start customizing!

Start the site by running npm run develop.

Your site is now running at http://localhost:8000!

If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can check out this shorter or longer tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.

📝 Using and modifying this starter

Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!

This starter creates a new Gatsby site that installs and configures the theme @lekoarts/gatsby-theme-emma.

Have a look at the theme's README and files to see what options are available and how you can shadow the various components including Theme UI. 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. Use defer to opt-in into Deferred Static Generation (DSG)
6. Write your content below the frontmatter

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. Use defer to opt-in into Deferred Static Generation (DSG) (optional)
6. Write your content below the frontmatter

Frontmatter reference:

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

Change your static folder

The static folder contains the icons, social media images and robots.txt. Don't forget to change these files, too! You can use Real Favicon Generator to generate the image files inside static.

🤔 Questions or problems?

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 project, you can head to the GitHub Discussions of the repository.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.

Themes

To learn more about Gatsby themes specifically, I recommend checking out the theme docs.

General

• For most developers, I recommend starting with the in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

• To dive straight into code samples, head to Gatsby's documentation. In particular, check out the How-to Guides and Reference items in the primary navigation.

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