NeXTSTEP Programming Mastermind

    @lekoarts/gatsby-theme-emilia

    3.0.4 • Public • Published

    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. Website Follow @lekoarts_de

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

    Live Preview View Design on Figma

    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
    • 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)
    sharp true Configure gatsby-plugin-sharp (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: `Homepage`, href: `https://www.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
    formatString DD.MM.YYYY Configure the date format for Date fields

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

    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 Patreon or GitHub Sponsor!

    Install

    npm i @lekoarts/gatsby-theme-emilia

    DownloadsWeekly Downloads

    232

    Version

    3.0.4

    License

    MIT

    Unpacked Size

    134 kB

    Total Files

    26

    Last publish

    Collaborators

    • lekoarts