Miss any of our Open RFC calls?Watch the recordings here! »

@arshad/gatsby-theme-phoenix

1.1.8 • Public • Published

@arshad/gatsby-theme-phoenix

A Gatsby theme that bundles a blog, portfolio, photography and podcast. It uses Tailwind CSS for theming and includes code highlighting with Prism, RSS feed, a dark mode and great typography. It is accessible and optimized for search engines.

Demo Version License PRs welcome!

Phoenix preview

gatsby new site arshad/gatsby-starter-phoenix

Installation

Step 1: Run the following command to create a new site

gatsby new my-site arshad/gatsby-starter-phoenix

Step 2: Configure .env

Copy .env.example to .env and update SITE_URL.

Step 3: Start developing

cd my-site/
gatsby develop

Adding content

Page

Place your pages inside content/pages as follows:

my-site
  ├── content
  │ └── pages
  │     └── about
  │         ├── image.jpg
  │         └── index.mdx
  ├── node_modules
  ├── gatsby-config.js
  └── package.json

content/pages/about/index.mdx:

title: Hello, I'm Nulla Texier
excerpt: Temporibus tenetur eveniet ipsa. Enim eum consequatur magnam. Nulla quaerat est nam consequatur magnam.

Post

Place your blog posts inside content/posts as follows:

my-site
  ├── content
  │ └── posts
  │     └── 2019-11-19-slug-for-post
  │         ├── image.jpg
  │         └── index.mdx
  ├── node_modules
  ├── gatsby-config.js
  └── package.json

content/posts/2019-11-19-slug-for-post/index.mdx:

---
title: Mollitia quaerat perspiciatis eaque vel officiis
date: 2018-09-01
excerpt: Nobis et distinctio ipsam officia rem similique. Ipsa facilis doloremque quos culpa similique quidem autem. Expedita doloribus.
image: ./image.jpg
caption: Illustration by <a href="https://illlustrations.co">illlustrations.co</a>
tags: ["nobis", "animi"]
---
 
Et aliquip labore id minim adipisicing excepteur labore in ex deserunt duis quis cillum in. Sint enim proident incididunt cillum esse sit sunt laboris dolore. Eu qui proident eu ut eiusmod sunt aliquip ut dolor. Ipsum consequat culpa officia dolor.

Projects

Place your projects inside content/projects as follows:

my-site
  ├── content
  │ └── projects
  │     └── name-of-project
  │         ├── image.jpg
  │         └── index.mdx
  ├── node_modules
  ├── gatsby-config.js
  └── package.json

content/projects/name-of-project/index.mdx:

---
title: Aspernatur voluptates
excerpt: Quos totam nihil saepe ipsam incidunt. Quo ipsam soluta sapiente.
url: https://example.com
image: image.jpg
---

Photos

Place your photos inside content/photos as follows:

site
  ├── content
  │   └── photos
  │       └── photo-1
  │           ├── photo.jpg
  │           └── index.mdx
  ├── node_modules
  ├── gatsby-config.js
  └── package.json

content/photos/photo-1/index.mdx

---
title: Proident enim aliqua
date: 2019-10-11
excerpt: Consequat consectetur mollit commodo nisi reprehent velit aliqua quis nisi laborum.
image: ./photo.jpg
---
 
Et aliquip labore id minim adipisicing excepteur labore in ex deserunt duis quis cillum in.

Configuration

The following theme options and configuration is available:

// gatsby-config.js
{
  title: `Phoenix.`,
  description: `Description for your site.`,
  siteUrl: process.env.SITE_URL,
  startUrl: `/`,
  copyright: `© YYYY Phoenix. All rights reserved.`,
  icon: `src/images/icon.png`,
  color: `#3C64F1`,
  menuLinks: [
    {
      name: "Home",
      link: "/",
    },
    {
      name: "Projects",
      link: "/projects",
    },
    {
      name: "Portfolio",
      link: "/portfolio",
    },
    {
      name: "Podcast",
      link: "/podcast",
    },
    {
      name: "About",
      link: "/about",
    },
    {
      name: "Contact",
      link: "/contact",
    },
  ],
  socialLinks: [
    {
      name: "Twitter",
      url: "https://twitter.com/arshadcn",
      icon: "twitter",
    },
    {
      name: "Github",
      url: "https://github.com/arshad",
      icon: "github",
    },
  ],
}

Customization

Gatsby uses shadowing for theme customization. You can read more about it here.

Support

Create an issue on the main repo @arshad/gatsby-themes.

👏 Credits

Install

npm i @arshad/gatsby-theme-phoenix

DownloadsWeekly Downloads

4

Version

1.1.8

License

MIT

Unpacked Size

117 kB

Total Files

35

Last publish

Collaborators

  • avatar