@lucis/gatsby-theme-lodge

gatsby-theme-lodge

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

Built with ❤️ 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:

Prop name	Type	Description
landing	Object	Landing component configuration (see Landing)
cards	Object	Cards component configuration (see Cards)
location	Object	Location component configuration (see Location)
gallery	Object	Gallery component configuration (see Gallery)

Landing

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

Configuration:

Prop name	Type	Description
landingText	Object	Describes the informations displayed in the Landing component (see LandingText)

LandingText

• Displays an animated set of texts to describe the Lodge

Configuration:

Prop name	Type	Description	Example
location	String	Textual address of the Lodge	Situada na Rua Siqueira Campos, Campina Grande - PB
lodgeName	String	Name of the Lodge	Regeneração Campinense nº 02
meetings	String	When do the Lodge's meetings happen?	quartas-feiras às 19:00hrs

Cards

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

Configuration:

Prop name	Type	Description
historia	CardEntry	Check EntryType below.
diretoria	CardEntry	Check EntryType below.
veneraveis	CardEntry	Check EntryType below.
filantropia	CardEntry	Check EntryType below.

CardEntry

Prop name	Type	Description	Example
title	String	Title of the card	O que é Maçonaria?
path	String	Path that will be used to the title link	/o-que-e-maconario
text	String	Content of the car	Free text.

Location

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

Configuration:

Prop name	Type	Description	Example
address	String	Address of the Lodge	Rua Siqueira Campos, 1020 - Campina Grande - PB
addressLink	String	Link that will be attached to the address displayed	https://goo.gl/maps/QdaPBrDC7ZqodP7RA
gMapsUrl	String	URL to Google Maps Iframe	Get it on Google Maps
title	String	Title to the address iframe	--

Gallery

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

Configuration:

Prop name	Type	Description	Example
pictures	String[][]	Array of tuples describing the name of the file and the respective alternative text	[['1', 'Alternative text 1'], ['2', 'Alternative Text 2']]

WIP