README.md

Free & Open Source Gatsby Themes by AdamQuadmon

Gatsby themes to quickly bootstrap your website!

It is ispired by:

• @LekoArts/gatsby-themes
• gatsby-theme-catalyst
• gatsby-theme-nicky-blog

Contents

This repository uses Yarn Workspaces and changesets to develop multiple packages together as a monorepo and renovate to keep deps updated. Be sure to install Yarn before setting up the development environment.

• examples: Contains the corresponding example sites for the themes.
• themes: Contains the themes themselves.
• scripts: Contains utils to handle stuff.

Scripts

in the scripts folder:

• mdx - create in csv/ folder posts.csv, areas.csv, cagegories.csv and tags.csv with mdx content from basePath following area and topic sections renaming topics to categories

Tools

• fast-csv - CSV parser and formatter
• front-matter - extract YAML front matter from strings

How to Contribute

Make sure that you have yarn installed on your machine (as it's mandatory for yarn workspaces). Fork this repository, clone it and run yarn in the root directory.

To launch the development server of an example site, use:

yarn workspace [examples/name] develop

Or for a build:

yarn workspace [examples/name] build

In the case of examples/lucifero this command would be yarn workspace lucifero develop. Now you can make changes to the respective theme and see them via Hot-Reloading.

Commit your changes to a feature branch of your fork and open up a PR against this repository. The PR will have checks in place which you can also run on your machine in preparation for the PR.

Have a look at the contributing guide to learn more.

🎓 Learning Gatsby Themes

Articles from lekoarts.de

• How I used Theme UI to build my Gatsby Themes library
• Setting up a Gatsby Themes workspace with TypeScript, ESLint & Cypress
• Specimens for Gatsby powered Design Systems
• Creating your own Status Dashboard with Gatsby

Official resources

• Gatsbyjs.com - Gatsby Themes
• Building a Theme
• Free egghead.io "Gatsby Theme Authoring" course

TODO

• fix MDX Blog
  • fix favicon and ogImage
  • use MdxBlog model
• [] use Strapi
• [] add theme translations
• [] add sub pages to navPage items
• [] document components (maybe using storybook)
• [] upgrade rehype-slug and rehype-sanitize once gatsby move to esm