@suldev/gatsby-theme-foundry v1.0.17

Foundry

Foundry is a core theme for all SUL websites. It's designed to speed up development by handling various standard features.

Modules

Foundry comes packaged with a number of modules:

Core

Foundry Core is responsible for bootstraping the website and various sub-modules.

Telemetry

Responsible for tracking, fingerprinting, UX and analytics. It will automatically install and execute Fathom (analytics), HotJar (Heatmaps) and Fignerprinting (Device IDs).

SEO

Establishes baseline SEO data and tags, including titles, descriptions and OpenGraph Images. Foundy also auto generates sitemaps and robots.txt files.

Usage

Intallation

npm install @sul/gatsby-theme-foundry

Foundry comes with a handful of configuration options:

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: `@sul/gatsby-theme-foundry`,
      options: {
        siteUrl: '', // required
      },
    },
  ],
}

Theme

Foundry comes packaged with a base @sul/ui theme. Add a custom theme by using component shadowing:

- src
  - @sul
    - gatsby-theme-foundry
      - theme
        - index.ts

export const theme = {
  ...
}

Roadmap

1.0.0 - Initial Release

• Complete MVP

1.1.0 - UX1 - Initial Component Library (Set 1)

• Initial set of components for rapid website prototyping