@lucis/gatsby-theme-lodge v1.1.36

gatsby-theme-lodge

Gatsby theme for building beautiful and customisable landing pages for Freemasons's Lodges. (about Freemasonry)

Built with :heart: for Brazilian Lodge "Acácia da Borborema" nº 41.

It uses gatsby-transformer-pages-json for building the site with full customization.

WIP ALERT: I'm still building this architecture and it will change overtime. The page creation is stil being done in the theme side but we will probably overcome this issue and move it to the plugin.

Install

yarn add @luciannojunior/gatsby-theme-lodge

How to use

In your gatsby-config.js:

module.exports = {
  plugins: [`@luciannojunior/gatsby-theme-lodge`],
}

Configuration

Most of this theme's customization happens in pages.json file, that is created automatically on your site's data folder (you can change this with contentPath option). This file must follow this pattern:

{
  "pages": {
    "home": {
      "homepage": true,
      "component": "Home",
      "props": {
        "landing": {
          "landingText": {
            "lodgeName": "Regeneração Campinense nº 02",
        ...
    },
   "o-que-e-maconaria": {
      "component": "Maconaria"
    },
    ...
  },
  "menu": [
    {
      "page": "home",
      "value": "Início"
    },
    ...
  ],
}

}

Pages

The pages objects declares which pages will be created in the Gatsbys site.

• A simple slugify heuristic is used using the page's name, which is described by the key provided (i.e: "o-que-e-maconaria" will create a page in the /o-que-e-maconaria path).
• The component provided will be resolved from gatsby-theme-lodge/src/components and rendered within the created page. We will provide default components to be used and you can also providing your own components using Component Shadowing.
• You should provide a homepage boolean attribute as true to the home page of you site, so we will build this page's path in / (or in the basePath provided to themes's settings)

Menu

• The menu array describes how the Menu component will show the items. It must reference pages by its name, or provide a path to a external URL.

Components

Home

• Default Home component. It composes some different components of that page (Landing, Cards, Location and Gallery).

Configuration:

Landing

• Wraps a video background (or image background for mobile users) and displays a couple of information about the Lodge.

Configuration:

LandingText

• Displays an animated set of texts to describe the Lodge

Configuration:

Cards

• Displays four content cards with links to site's page (static links for now).

Configuration:

CardEntry

Location

• Displays info about the Lodge's location and a Google Maps iframe to that adress.

Configuration:

Gallery

• Slideshow that loops a set of pictures (that should be provided inside static/images folder).

Configuration:

WIP