Skip to content

Latest commit

 

History

History
executable file
·
142 lines (95 loc) · 6.62 KB

README.md

File metadata and controls

executable file
·
142 lines (95 loc) · 6.62 KB

LekoArts

Gatsby Starter Portfolio: Emilia

Gatsby Starter Portfolio: Emilia is released under the 0BSD license. GitHub Sponsors Website Follow @lekoarts_de

Minimalistic portfolio/photography site with masonry grid, page transitions and big images. Themeable with Theme UI. Using the Gatsby Theme @lekoarts/gatsby-theme-emilia.

Demo Website

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

✨ Features

  • MDX
  • Fully customizable through the usage of Gatsby Themes (and Theme UI)
  • Light Mode / Dark Mode
  • Page Transitions
  • Masonry grid and focus on big images
  • SEO (Sitemap, OpenGraph tags, Twitter tags)
  • WebApp Manifest

⏱️ Quick Start

Deploy this starter with one click on Netlify:

Deploy to 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-emilia https://github.com/LekoArts/gatsby-starter-portfolio-emilia

2. Navigate to your new project.

cd gatsby-starter-portfolio-emilia

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

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-emilia/ to shadow/override files. The Theme UI config can be configured by shadowing its files in src/gatsby-plugin-theme-ui/.

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)
  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:

---
cover: "./sean-foley-0JD7kvxAq0Y-unsplash.jpg"
date: "2019-09-10"
title: "Emilia"
defer: false
slug: "/my-slug"
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).

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

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