# gatsby-theme-aurora

> The quickest way to start building a beautiful, custom, fully-featured [Gatsby][] site

Latest version **0.0.11** (published 2019-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-theme-aurora
pnpm add gatsby-theme-aurora
yarn add gatsby-theme-aurora
bun add gatsby-theme-aurora
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2019-10-17 |
| First published | 2019-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | johno |

## Links

- npm: https://www.npmjs.com/package/gatsby-theme-aurora
- npm.io page: https://npm.io/package/gatsby-theme-aurora

## Dependencies (7)

- [theme-ui](https://npm.io/package/theme-ui.md) ^0.2.44
- [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^1.5.1
- [@emotion/core](https://npm.io/package/@emotion/core.md) ^10.0.21
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.5.1
- [@theme-ui/preset-base](https://npm.io/package/@theme-ui/preset-base.md) ^0.2.44
- [gatsby-plugin-theme-ui](https://npm.io/package/gatsby-plugin-theme-ui.md) ^0.2.43
- [gatsby-theme-blog-core](https://npm.io/package/gatsby-theme-blog-core.md) ^1.1.0

## Recent versions

- 0.0.11 (latest) — 2019-10-17
- 0.0.10 — 2019-10-11
- 0.0.9 — 2019-10-11
- 0.0.8 — 2019-10-10

## README

# Aurora - A Gatsby theme

The quickest way to start building a beautiful, custom, fully-featured [Gatsby][] site

[View Live Demo][live demo]

- Multiple homepage layouts
- Light and Dark Mode
- Simple style customization with [Theme UI][]
- Syntax highlighting for code blocks
- Highlight to share
- Reading time indicators
- Accessible by default
- Tags, pagination, search, and more

## Getting Started

Use the Gatsby CLI to create a new site based on the Aurora starter.

```sh
npx gatsby new my-blog https://github.com/johno/gatsby-starter-aurora
```

To run the development server or build your site, use the following commands:

```sh
# Run development server
npm start

# Build site
npm run build
```

### Manual Installation

To add the Aurora theme to an existing Gatsby site, install the theme directly.

```sh
npm install gatsby-theme-aurora
```

Then add it to your Gatsby config.

```js
// gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-theme-aurora',
      options: {}
    },
  ],
}
```

## Configuring Site Metadata

In your Gatsby config, use the following keys to configure your site.

```js
// gatsby-config.js
module.exports = {
  siteMetadata: {
    // Root document title for your site
    title: 'My Blog',
    // Used for meta tags
    description: 'A blog about things I like to write about',
    // Author name
    author: 'Jane Doe',
    // Used for meta tags
    siteURL: 'https://example.com',
    // Links for social network profiles
    socialLinks: [
      {
        name: 'Twitter',
        url: 'https://twitter.com/jxnblk',
      },
    ],
  },
  plugins: [
    {
      resolve: 'gatsby-theme-aurora',
      options: {},
    },
  ]
}
```

## Adding a Post

To create a new blog post, add an `.mdx` file to `content/posts`.
Include the post's title and date in frontmatter.

```mdx
---
title: My First Blog Post
date: 2019-10-10
image: './images/hero.jpg'
---

This is my first blog post!
```

<!--
## Adding an Author

To add authors to your site, create a `content/authors/authors.yml` file and add as many authors as you'd like.
-->

## Options

Use the following options to customize the theme.

Name | Description | Default Value
---|---|---
`tags` | Enable tags for blog posts | `false`
`pagination` | Enable pagination for blog posts index page | `false`
<!-- `authorsPage` | Creates author pages | `false` -->
`layout` | Switch between `grid` or `list` homepage layout | `grid`
`theme` | Enables one of the built-in, preset theme styles | `base`
`mdx` | Set this option to `false` when using a custom instance of `gatsby-plugin-mdx` | `true`

## Theming

Use one of the built-in themes to adjust the look and feel of your sites typography and colors.

### Customization

Virtually any aspect of the built in theme styles can be customized by shadowing the `src/gatsby-plugin-theme-ui/index.js` file.

```js
// example src/gatsby-plugin-theme-ui/index.js
import base from 'gatsby-theme-aurora/theme'

export default {
  ...theme,
  colors: {
    text: '#000',
    background: '#fff',
    primary: 'tomato',
    modes: {
      dark: {
        text: '#fff',
        background: '#000',
        primary: 'magenta',
      },
    },
  },
}
```

## Shadowing

All components in the theme can be customized by using [component shadowing][].

## Data Models

### Post
### Site Metadata
<!-- ### Author -->

TK

[live demo]: #!
[gatsby]: https://gatsbyjs.org
[theme ui]: https://theme-ui.com
[component shadowing]: https://www.gatsbyjs.org/docs/themes/shadowing/

---
_Source: https://npm.io/package/gatsby-theme-aurora · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._