gatsby-theme-hyperobjekt-core
v1.0.27
Published
Core Hyperobjekt theme for GatsbyJS designed to be used as an accelerated starting point in website development.
Downloads
17
Maintainers
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:
{
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"] }
]
}
}
}