# gatsby-theme-hyperobjekt-core

> Core Hyperobjekt theme for GatsbyJS designed to be used as an accelerated starting point in website development.

Latest version **1.0.27** (published 2021-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-theme-hyperobjekt-core
pnpm add gatsby-theme-hyperobjekt-core
yarn add gatsby-theme-hyperobjekt-core
bun add gatsby-theme-hyperobjekt-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.27 |
| Published | 2021-03-16 |
| First published | 2020-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 44 |
| Unpacked size | 69.5 KB |
| Known vulnerabilities | 0 (+6 in 3 direct dependencies) |
| Install scripts | no |
| Author | Lane Olson |
| Maintainers | laneolson |
| Keywords | gatsby, gatsby-theme, gatsby-plugin |

## Links

- npm: https://www.npmjs.com/package/gatsby-theme-hyperobjekt-core
- npm.io page: https://npm.io/package/gatsby-theme-hyperobjekt-core

## Dependencies (44)

- [clsx](https://npm.io/package/clsx.md) ^1.1.1
- [katex](https://npm.io/package/katex.md) ^0.12.0
- [mdx-embed](https://npm.io/package/mdx-embed.md) ^0.0.14
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^1.6.18
- [react-icons](https://npm.io/package/react-icons.md) ^3.11.0
- [remark-math](https://npm.io/package/remark-math.md) ^3.0.1
- [remark-slug](https://npm.io/package/remark-slug.md) ^6.0.0
- [gatsby-image](https://npm.io/package/gatsby-image.md) ^2.4.21
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0
- [react-scroll](https://npm.io/package/react-scroll.md) ^1.8.1
- [rehype-katex](https://npm.io/package/rehype-katex.md) ^4.0.0
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.6.18
- [@reach/skip-nav](https://npm.io/package/@reach/skip-nav.md) ^0.11.2
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.11.0
- [gatsby-plugin-mdx](https://npm.io/package/gatsby-plugin-mdx.md) 1.2
- [@hyperobjekt/hooks](https://npm.io/package/@hyperobjekt/hooks.md) 1.0.8
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.9.1
- [gatsby-plugin-feed](https://npm.io/package/gatsby-plugin-feed.md) ^2.5.14
- [gatsby-plugin-sharp](https://npm.io/package/gatsby-plugin-sharp.md) ^2.6.38
- [gatsby-remark-katex](https://npm.io/package/gatsby-remark-katex.md) ^3.3.13
- [gatsby-remark-images](https://npm.io/package/gatsby-remark-images.md) ^3.3.32
- [prism-react-renderer](https://npm.io/package/prism-react-renderer.md) ^1.1.1
- [gatsby-plugin-offline](https://npm.io/package/gatsby-plugin-offline.md) ^3.2.30
- [gatsby-plugin-sitemap](https://npm.io/package/gatsby-plugin-sitemap.md) ^2.4.14
- [gatsby-plugin-manifest](https://npm.io/package/gatsby-plugin-manifest.md) ^2.4.33
- [gatsby-background-image](https://npm.io/package/gatsby-background-image.md) ^1.1.2
- [gatsby-plugin-mdx-embed](https://npm.io/package/gatsby-plugin-mdx-embed.md) ^0.0.13
- [gatsby-transformer-json](https://npm.io/package/gatsby-transformer-json.md) ^2.4.14
- [gatsby-transformer-yaml](https://npm.io/package/gatsby-transformer-yaml.md) ^2.4.13
- [gatsby-plugin-robots-txt](https://npm.io/package/gatsby-plugin-robots-txt.md) ^1.5.3
- [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.3.32
- [gatsby-theme-material-ui](https://npm.io/package/gatsby-theme-material-ui.md) ^1.0.13
- [gatsby-transformer-sharp](https://npm.io/package/gatsby-transformer-sharp.md) ^2.5.14
- [gatsby-plugin-catch-links](https://npm.io/package/gatsby-plugin-catch-links.md) ^2.3.15
- [gatsby-remark-smartypants](https://npm.io/package/gatsby-remark-smartypants.md) ^2.3.13
- [gatsby-plugin-page-creator](https://npm.io/package/gatsby-plugin-page-creator.md) ^2.3.27
- [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^3.3.13
- [gatsby-remark-reading-time](https://npm.io/package/gatsby-remark-reading-time.md) ^1.1.0
- [@n8tb1t/use-scroll-position](https://npm.io/package/@n8tb1t/use-scroll-position.md) ^2.0.3
- [gatsby-remark-external-links](https://npm.io/package/gatsby-remark-external-links.md) ^0.0.4
- [gatsby-remark-relative-images](https://npm.io/package/gatsby-remark-relative-images.md) ^2.0.2
- [gatsby-remark-copy-linked-files](https://npm.io/package/gatsby-remark-copy-linked-files.md) ^2.3.19
- [gatsby-remark-responsive-iframe](https://npm.io/package/gatsby-remark-responsive-iframe.md) ^2.4.17

## Recent versions

- 1.0.27 (latest) — 2021-03-16
- 1.0.26 — 2021-02-18
- 1.0.24 — 2021-01-08
- 1.0.23 — 2020-12-17
- 1.0.22 — 2020-12-16
- 1.0.21 — 2020-12-16
- 1.0.20 — 2020-12-16
- 1.0.19 — 2020-12-16
- 1.0.18 — 2020-12-15
- 1.0.17 — 2020-12-15
- 1.0.16 — 2020-12-04
- 1.0.15 — 2020-11-26
- 1.0.14 — 2020-11-11
- 1.0.13 — 2020-11-11
- 1.0.12 — 2020-11-10
- … 12 more at https://npm.io/package/gatsby-theme-hyperobjekt-core/versions

## README

# Gatsby Theme Hyperobjekt Core

This acts as a core theme on which all other themes are based. It houses a basic site architecture, as much logic as possible, along with most dependencies. Imagine this as the foundation of a house. There are some latent components which are used to enable easy shadowing in child themes. There are minimal styles applied at this stage.

## Theme Options

| Option                   | Values        | Description                                                                                 |
| ------------------------ | ------------- | ------------------------------------------------------------------------------------------- |
| `contentPath`            | String        | Defaults to "content/pages", determines where the pages are created from.                   |
| `assetPath`              | String        | Defaults to "content/assets", determines where the page assets like images are located.     |
| `displaySiteLogo`        | true or false | Defaults to true, controls whether the logo is displayed                                    |
| `displaySiteLogoMobile`  | true or false | Defaults to true, controls whether the logo is displayed at the mobile breakpoint           |
| `displaySiteTitle`       | true or false | Defaults to true, controls whether the site title is displayed                              |
| `displaySiteTitleMobile` | true or false | Defaults to true, controls whether the site title is displayed at the mobile breakpoint     |
| `useStickyHeader`        | true or false | Defaults to false, controls whether the header is sticky or static                          |
| `useShrinkHeader`        | true or false | Defaults to false, controls whether the header shrinks on scroll                            |
| `useSocialLinks`         | true or false | Defaults to true, controls whether the social links are displayed or not                    |
| `useDarkMode`            | true or false | Defaults to true, controls whether the dark mode toggle is available.                       |
| `useKatex`               | true or false | Defaults to false, enables gatsby-remark-katex for displaying math equations.               |
| `typekitId`              | String        | Defaults to null, specify an ID for a font collection to load from typekit                  |
| `remarkImagesWidth`      | Integer value | Defaults to 1440, allows you to customize the image width option for gatsby-remarks-images. |
| `templates`              | Object        | Defaults to empty object, use this to provide custom template types                         |

Example Config:

```js
   {
      resolve: `gatsby-theme-hyperobjekt-core`,
      options: {
        "contentPath": "content/pages",
        "assetPath": "content/assets",
        "header": {
          "displaySiteLogo": true,
          "displaySiteTitle": false,
          "displaySiteLogoMobile": true,
          "displaySiteTitleMobile": false,
          "useStickyHeader": true,
          "useShrinkHeader": true,
          "mobileMenuBreakpoint": 768,
          "headerContentMaxWidth": 960,
          "headerHeight": 80,
          "shrinkHeaderHeight": 56,
          "shrinkOffset": -32
        },
        "useSocialLinks": true,
        "useDarkMode": true,
        "useKatex": false,
        "contentMaxWidth": 768,
        "remarkImagesWidth": 1440,
        "fonts": {
          "google": [
            { "family": "Montserrat", "variants": ["300", "400", "500", "700"] },
            { "family": "Nunito", "variants": ["300", "400", "500"] },
            { "family": "Fira Mono", "variants": ["400"] }
          ]
        }
      }
    }
```

---
_Source: https://npm.io/package/gatsby-theme-hyperobjekt-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
