Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@lekoarts/gatsby-theme-minimal-blog-core

LekoArts821MIT6.2.4

Core Theme for @lekoarts/gatsby-theme-minimal-blog. This theme implements the Post and Page node interfaces and exports templates (+ queries) which you can shadow.

gatsby, gatsby-theme, gatsby-plugin, lekoarts

readme

Gatsby Theme

@lekoarts/gatsby-theme-minimal-blog-core

@lekoarts/gatsby-theme-minimal-blog-core is released under the MIT license. Current npm package version. Downloads per month on npm. Total downloads on npm. Website Follow @lekoarts.de

Core Theme for @lekoarts/gatsby-theme-minimal-blog. This theme implements the Post and Page node interfaces and exports templates (+ queries) which you can shadow.

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

Installation

npm install @lekoarts/gatsby-theme-minimal-blog-core

Usage

Theme options

Key Default Value Description
basePath / Root url for the theme
blogPath /blog url for the blog post overview page
tagsPath /tags url for the tags overview page and prefix for tags (e.g. /tags/my-tag)
postsPath content/posts Location of posts
postsPrefix / Prefix for all individual blog posts
pagesPath content/pages Location of additional pages (optional)
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)
formatString DD.MM.YYYY Configure the date format for Date fields

The usage of content/pages is optional.

Shadowing

Please read the guide Shadowing in Gatsby Themes to understand how to customize the theme! You can also have a look at @lekoarts/gatsby-theme-minimal-blog to see it in action. Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-minimal-blog-core/ to shadow/override files.

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 Bluesky and share the project with me.

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

changelog

Change Log

6.2.4

Patch Changes

6.2.3

Patch Changes

6.2.2

Patch Changes

6.2.1

Patch Changes

  • 409bba45 Thanks @LekoArts! - Remove link to my Patreon page. To simplify things I disabled my Patreon. If you want to support my OSS work, please consider using GitHub sponsors or Ko-fi. Thanks!

6.1.3

Patch Changes

6.1.2

Patch Changes

  • #1204 07e3c8a3 Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

6.1.1

Patch Changes

  • #1161 6985b62e Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

6.1.0

Minor Changes

  • #1119 02844608 Thanks @LekoArts! - Starting with Gatsby 5.3 ESM in Gatsby files is supported now! So you can write gatsby-config.mjs or gatsby-node.mjs.

    Therefore this theme was updated to use ESM for its source code. This shouldn't make a difference for actually using the theme as behavior stays the same. If this is not the case, please open an issue!

    One benefit of now using ESM behind the scenes is that e.g. the remark-* packages could be updated to their latest versions (they are ESM-only). Yey for using up-to-date software.

  • #1119 02844608 Thanks @LekoArts! - Because this theme now uses a Gatsby Head API feature that was introduced in Gatsby 5.5 the peerDependencies range was updated from ^5.0.0 to ^5.5.0.

    Please also update your gatsby package when updating this theme.

Patch Changes

6.0.5

Patch Changes

6.0.3

Patch Changes

  • #1076 8007bb38 Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

6.0.0

Major Changes

Patch Changes

5.0.3

Patch Changes

  • be91f14a Thanks @renovate[bot]! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

5.0.1

Patch Changes

5.0.0

Major Changes

#967 ee969f3

In preparation for the upcoming Gatsby 5 release this release will focus on some breaking changes unrelated to the gatsby core package. Another new major version will follow once Gatsby 5 is out so that you can upgrade in steps.

Features:

Breaking Changes:

  • Any breaking changes from theme-ui between v0.11 and v0.15
  • Bump react & react-dom peerDependency to >=18.0.0
  • Removal of siteLanguage from siteMetadata
  • The MDX components are not managed by gatsby-plugin-theme-ui/components anymore but defined in a <MDXProvider> in src/components/layout
  • useColorSchemeMediaQuery in Theme UI config is set to system
  • Removal of body from the Post and Page type. The field contentFilePath was added.
  • Removal of gatsby-omni-font-loader
  • body font style is changed from "IBM Plex Sans" to a system font stack
  • Removal of react-live
  • Change in syntax of highlighting lines, adding code title, and adding line numbers
  • The showLineNumbers option is false by default now

Migration:

  • Internally the necessary changes of the gatsby-plugin-mdx migration guide were made, but if you set the mdx option to false and/or shadowed the theme in any way, you'll need to read the migration guide to e.g. change your gatsby-config. You'll also need to add any remarkPlugins or rehypePlugins that the theme is adding by default.
  • MDX 2 is more strict about the allowed syntax, so you'll need to update your MDX content to be compliant.
  • See Theme UI's migration guide
  • If you shadowed a file or used react-helmet in any form in your site, you'll either need to migrate to the Gatsby Head API or re-install the necessary dependencies. By default, the theme no longer ships with react-helmet as internally everything was migrated to Gatsby Head API. To have the lang tag work correctly on the <html> element you'll need to set it by using the setHtmlAttributes API. The current starter already has this included (you can copy it from there). Thus the <Seo> component should only be used together with Gatsby Head API.
  • With the removal of gatsby-omni-font-loader in the example you'll now need to self-host your fonts and change the Theme UI config. The theme switched to a system font stack in its Theme UI config and the example doesn't provide any custom font anymore.
  • If you want to continue using react-live, you have to add the dependency and shadow the <Code> component.

  • The syntax for adding code titles changed. Before:

    ```js:title=test.js
// content
```

    After:

    ```js title=test.js
// content
```

  • The syntax for adding line highlighting changed. Before:

    ```js {1,2-3}
// content
```

    After:

    ```js highlight=1,2-3
// content
```

  • The syntax for adding line numbers changed. You no longer negate line numbers (previously noLineNumbers) but opt-in. Before:

    ```js noLineNumbers
// content that had line numbers by default
```

    After:

    ```js withLineNumbers
// content
```

  • All syntax changes together. Before:

    ```js:title=test.js {1,2-3}
// content
```

    After:

    ```js title=test.js highlight=1,2-3 withLineNumbers
// content
```

Patch Changes

4.1.8

Patch Changes

4.1.7

Patch Changes

  • #915 93e4927 Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

4.1.6

Patch Changes

  • #895 beb1c63 Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

4.1.5

Patch Changes

  • #869 dbe1a0e Thanks @LekoArts! - chore: Update peerDependencies to include React 18

  • #866 dff0be1 Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

4.1.4

Patch Changes

  • #812 334f0cb Thanks @renovate! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

4.1.2

Patch Changes

4.1.0

Patch Changes

  • #713 71e15ca Thanks @renovate! - fix(deps): update dependency gatsby-plugin-sharp to ^4.0.1 for gatsby-theme-minimal-blog-core

4.0.0

Major Changes

#641 1598dd6

Compatibility with Gatsby 4. Upgrade your theme to be able to use the new Gatsby release. Leverage Deferred Static Generation (DSG), Server-Side Rendering (SSR) and Parallel Query Running (PQR) with this new release. Learn more about Gatsby 4.

All Gatsby related packages were also upgraded to their latest new major version.

See Gatsby 4 Migration Guide

BREAKING CHANGES:

  • Minimum required Node.js version: >=14.15.0
  • Minimum required gatsby version: ^4.0.0
  • Upgraded Theme UI (packages) from ^0.9.0 to ^0.11.0

New Features:

  • You can now use defer: true in the frontmatter of your page/post to mark the page as deferred (for Deferred Static Generation)

Bug Fixes:

  • The slug key on posts now correctly respects the postsPrefix option (fixes https://github.com/LekoArts/gatsby-themes/issues/699). This means that the URL now also contains the postsPrefix option (which is potentially breaking if you rely on this being different).
  • The slug key on pages now correctly respects the basePath option. This means that the URL now also contains the basePath option (which is potentially breaking if you rely on this being different).

Migration:

  • If you relied on slug both for posts or pages you'll need to check if your URLs are still as expected
  • If you used Theme UI in custom components, check the Theme UI changelog
  • Update CI/local environment to account for the new Node.js requirement

3.1.3

Patch Changes

  • #696 d0b7944 Thanks @LekoArts! - chore: Improve READMEs with more instructions

    Links to changelogs and places to ask questions were added.

3.1.2

Patch Changes

  • #695 afba2ff Thanks @LekoArts! - fix(deps): update minor and patch dependencies for gatsby-theme-minimal-blog-core

3.1.1

Patch Changes

3.1.0

Minor Changes

  • #644 4fccc44 Thanks @LekoArts! - feat(minimal-blog-core): Set backgroundColor in gatsby-remark-images to transparent

    By default the plugin has white as a backgroundColor. This is a problem for transparent images (PNG) that are viewed in the dark theme version of the site. So as a sensible default I'll set this to transparent now. If you relied on this being white and want to restore the old behavior, set the mdx option to false for the theme, copy/paste the existing gatsby-plugin-mdx config into your own site.

    For example, your gatsby-config.js then will look like this:

    module.exports = {
  // + Rest of your config
  plugins: [
    // + rest of your plugins
    {
      resolve: `@lekoarts/gatsby-theme-minimal-blog`,
      options: {
        mdx: false,
        // + rest of the options you want to set
      },
    },
    {
      resolve: `gatsby-plugin-mdx`,
      options: {
        lessBabel: true,
        extensions: [`.mdx`, `.md`],
        gatsbyRemarkPlugins: [
          {
            resolve: `gatsby-remark-images`,
            options: {
              maxWidth: 960,
              quality: 90,
              linkImagesToOriginal: false,
            },
          },
        ],
        plugins: [
          {
            resolve: `gatsby-remark-images`,
            options: {
              maxWidth: 960,
              quality: 90,
              linkImagesToOriginal: false,
            },
          },
        ],
      },
    },
  ],
};

3.0.3

Patch Changes

3.0.2

Patch Changes

3.0.1

Patch Changes

  • #597 e1aec09 Thanks @renovate! - fix(deps): update packages

    Renovate Bot updates:

    • @react-spring/parallax ^9.1.2 -> ^9.2.3
    • @react-spring/web ^9.1.2 -> ^9.2.3
    • gatsby-plugin-catch-links ^3.6.0 -> ^3.7.0
    • gatsby-plugin-image ^1.6.0 -> ^1.7.0
    • gatsby-plugin-mdx ^2.6.0 -> ^2.7.0
    • gatsby-plugin-react-helmet ^4.6.0 -> ^4.7.0
    • gatsby-plugin-sharp ^3.6.0 -> ^3.7.0
    • gatsby-remark-images ^5.3.0 -> ^5.4.0
    • gatsby-source-filesystem ^3.6.0 -> ^3.7.0
    • gatsby-transformer-sharp ^3.6.0 -> ^3.7.0

  • #605 b2822c0 Thanks @LekoArts! - fix: Don't use nullish coalescing

    Support for Node versions older than 14+

3.0.0

Major Changes

#599 1785dcf Thanks @LekoArts!

Breaking Changes

  1. Using lessBabel option for gatsby-plugin-mdx
  2. Updating theme-ui from v0.3 to v0.9 and thus also emotion from v10 to v11
  3. Updating all Gatsby related packages to latest
  4. Removed gatsby-plugin-typescript
  5. Removed gatsby-plugin-feed
  6. Removed typeface-ibm-plex-sans npm package

Migrating

  1. The lessBabel option might break your setup in some edge cases. If it doesn't work, turn on the mdx option and choose your own config for gatsby-plugin-mdx
  2. The changelog/migration guide for theme-ui is here: https://theme-ui.com/migrating and for emotion here: https://emotion.sh/docs/emotion-11
  3. Gatsby v3 migration guide: https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/
  4. The TypeScript plugin isn't necessary anymore with Gatsby v3
  5. The plugin and its config was moved to the starter. You can copy the configuration from there into your own gatsby-config.js
  6. The starter now handles loading the font (via gatsby-omni-font-loader). This enables you to switch the primary font more easily (once you updated the Theme UI config). You can copy the configuration from there into your own gatsby-config.js

Improvements

Updates to Starter

If you only cloned the starter (https://github.com/LekoArts/gatsby-starter-minimal-blog) and didn't change anything else this section will be more relevant to you.

  • Conditionally add gatsby-plugin-google-analytics
  • Add FAST_DEV flag
  • Update to all latest Gatsby (+ plugins) versions
  • Move gatsby-plugin-feed from theme to starter
  • Use gatsby-omni-font-loader to load the primary font ("IBM Plex Sans") instead of in the theme itself

2.7.6

Patch Changes

  • 47f747e #559 Thanks @renovate! - Dependency updates for various packages, including theme-ui and gatsby related packages (includes improvements for gatsby-plugin-image)

2.7.5

Patch Changes

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.6.3 (2020-11-11)

Note: Version bump only for package @lekoarts/gatsby-theme-minimal-blog-core

2.6.2 (2020-11-04)

Bug Fixes

  • gatsby-theme-minimal-blog-core: Use postPrefix for posts, not pages (d389326)

2.6.1 (2020-11-02)

Bug Fixes

2.6.0 (2020-11-01)

Features

  • gatsby-theme-minimal-blog: Add postsPrefix option (bc172cd), closes #512

2.5.2 (2020-10-25)

Bug Fixes

2.5.1 (2020-10-10)

Note: Version bump only for package @lekoarts/gatsby-theme-minimal-blog-core

2.5.0 (2020-09-25)

Features

  • minimal-blog: Add Canonical URL support (#494) (0e9d7ac)

2.4.4 (2020-09-25)

Bug Fixes

2.4.3 (2020-09-16)

Bug Fixes

2.4.2 (2020-09-10)

Bug Fixes

2.4.1 (2020-08-28)

Bug Fixes

  • minimal-blog: Fix code block CSS positioning (#480) (98b6cac)

2.4.0 (2020-08-27)

Features

2.3.11 (2020-08-27)

Bug Fixes

2.3.10 (2020-07-09)

Bug Fixes

  • deps: update dependency gatsby-plugin-sharp to ^2.6.18 (#445) (5aad537)

2.3.9 (2020-07-04)

Bug Fixes

  • remove folder creation in onPreBootstrap step (#440) (ba92910)

2.3.8 (2020-07-03)

Bug Fixes

2.3.7 (2020-07-02)

Bug Fixes

2.3.6 (2020-06-08)

Bug Fixes

2.3.5 (2020-05-29)

Bug Fixes

2.3.4 (2020-05-12)

Note: Version bump only for package @lekoarts/gatsby-theme-minimal-blog-core

2.3.3 (2020-05-04)

Bug Fixes

2.3.2 (2020-05-02)

Note: Version bump only for package @lekoarts/gatsby-theme-minimal-blog-core

2.3.1 (2020-04-28)

Bug Fixes

2.3.0 (2020-04-27)

Features

2.2.7 (2020-04-24)

Bug Fixes

2.2.6 (2020-04-13)

Bug Fixes

2.2.5 (2020-04-12)

Bug Fixes

2.2.4 (2020-04-12)

Bug Fixes

2.2.3 (2020-04-01)

Note: Version bump only for package @lekoarts/gatsby-theme-minimal-blog-core

2.2.2 (2020-03-31)

Bug Fixes

2.2.1 (2020-03-04)

Bug Fixes

2.2.0 (2020-02-29)

Features

  • Add excerpt, description and timeToRead to queries (8c38636), closes #274

2.1.0 (2020-02-27)

Features

2.0.2 (2020-02-27)

Bug Fixes

2.0.1 (2020-02-16)

Bug Fixes

2.0.0 (2020-01-23)

Bug Fixes

Features

  • Change config format on minimal-blog theme (#234) (bdeb670)

BREAKING CHANGES

  • The navigation and externalLinks options are no longer on the siteMetadata but now in the theme options itself.

1.1.1 (2020-01-17)

Bug Fixes

1.1.0 (2020-01-07)

Features

  • gatsby-theme-minimal-blog-core: Custom slug for blog posts via frontmatter (05cff1e), closes #217

1.0.4 (2019-12-31)

Bug Fixes

1.0.3 (2019-12-03)

Bug Fixes

1.0.2 (2019-11-25)

Bug Fixes

1.0.1 (2019-11-16)

Features