📸 Polaroid is a photography-focused Gatsby theme for building portfolio websites.
MIT License
Polaroid is a photography-focused Gatsby theme for building portfolio websites. It supports an MDX blog with tags/categories, syntax-highlighted code blocks, Theme UI for dark mode, and Typescript.
Designed & developed by Arpit Sheth.
npm i --save @shetharp/gatsby-theme-polaroid
# or
yarn add @shetharp/gatsby-theme-polaroid
gatsby-config.js
filemodule.exports = {
plugins: ["@shetharp/gatsby-theme-polaroid"],
};
Modify the theme options and site metadata in your gatsby-config.js
file.
Create .mdx
files for your site's pages or posts. By default this should be in your site's content/posts
and content/pages
directories. You should create these directories if they don't already exist.
Shadow, override, and customize the theme to fit your needs. See the list of features below for more info.
gatsby new gatsby-theme-custom https://github.com/shetharp/gatsby-theme-polaroid
cd gatsby-theme-custom
yarn
yarn workspace demo develop
Replace gatsby-theme-custom
with whatever you wish to name your theme.
The theme
workspace directory contains the components, styles, and theme configurations.
package.json
to match the details for your theme (such as name, author, repository, etc.)The demo
workspace directory contains the content, components, and styles for an example site that consumes the theme.
package.json
to include your theme as a dependency. Make sure the name of the dependency matches the name in your theme's package.json
file!gatsby-config.js
to include your theme as a pluginUnder the hood, Polaroid is built on top of the functionality provided by @lekoarts/gatsby-theme-minimal-blog-core. Polaroid provides additional features, especially those that enhance the user experience for a photography-focused portfolio website and blog.
Polaroid lets you quickly build a production-ready website that supports the following out of the box:
Photo-rich portfolio
MDX Blog Posts and Site Pages
Built with Theme UI
Easy to Customize with Typescript
data
for the header, toggle header menu, and footerThe Polaroid Theme wiki contains more documentation on how to add content, customize the theme, and how to use its features.
It will help if you have some basic experience with Yarn workspaces, Gatsby, and Gatsby themes. If you don't have much experience with this, I suggest looking into these resources:
This repo uses Yarn workspaces and Gatsby, so make sure you have them installed on your machine.
cd
into ityarn
theme
directory. To update the demo site, make changes in the demo
directory.yarn workspace demo develop
yarn workspace demo build
Thank you for helping make this project better!