Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TryGhost/Lyra

A paid-members theme for Ghost
https://github.com/TryGhost/Lyra

ghost ghost-members ghost-theme journalism paid-memberships paid-subscriptions publishing

Last synced: about 2 months ago
JSON representation

A paid-members theme for Ghost

Host: GitHub
URL: https://github.com/TryGhost/Lyra
Owner: TryGhost
License: mit
Created: 2019-10-20T09:12:15.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2023-07-06T12:06:35.000Z (about 1 year ago)
Last Synced: 2024-04-14T05:11:51.491Z (5 months ago)
Topics: ghost, ghost-members, ghost-theme, journalism, paid-memberships, paid-subscriptions, publishing
Language: CSS
Homepage: https://lyra.ghost.io
Size: 1.25 MB
Stars: 176
Watchers: 19
Forks: 110
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-ghost - Lyra
awesome-starred - TryGhost/Lyra - A paid-members theme for Ghost (publishing)

README

# Lyra

A paid-members publication for Ghost. Can be used with no code knowledge required.

# Installation instructions

1. [Download this theme](https://github.com/TryGhost/Lyra/archive/main.zip)
2. Log into Ghost, and go to the `Design` settings area to upload the zip file
3. Unzip the theme archive on your computer and locate the file called `routes.yaml`
4. Inside Ghost admin, go to the `Labs` settings area and scroll down until you see the `Custom Routes` section
5. Upload the `routes.yaml` from this theme

That's it! You now have a Ghost publication which supports free and paid memberships. If you need help, check out the Ghost members documentation or chat with other Ghost users on Ghost forum.

![Screenshot of a subscribers only post](https://user-images.githubusercontent.com/120485/67228748-1fdd1400-f464-11e9-921f-ecbf5f412ed5.png)

# Upgrade instructions

1. [Download this theme](https://github.com/TryGhost/Lyra/archive/refs/heads/main.zip) and rename the zip for ease of identification in Ghost later. For example `2022-10-20_Lyra-main.zip`
2. Log into Ghost, 4. go to the `Labs` settings area and scroll down until you see the `Routes` section
3. Download your current `routes.yaml` file
4. Next go to the `Design` settings area and click `Change Theme` at the bottom of the navigation pane
5. Click the `Upload theme` button in the top right and upload the zip file you downloaded and renamed earlier (for example `2022-10-20_Lyra-main.zip`)
6. You will now see two instances of Lyra similar to the screenshot below
![Themes list showing two copies of Lyra](docs/TwoLyraInstances.png)
7. Ensure your new Lyra theme is active (based on the renamed zip from earlier, `lyra (2020-10-31_Lyra-main)` in the screenshot)
8. Delete the previous Lyra theme (`lyra (Lyra-master)` in the screenshot)
9Upload `routes.yaml` as required (see _Installation instructions_ above)

# Development

Styles are compiled using Gulp/PostCSS to polyfill future CSS spec. You'll need [Node](https://nodejs.org/), [Yarn](https://yarnpkg.com/) and [Gulp](https://gulpjs.com) installed globally. After that, from the theme's root directory:

```bash
# Install
yarn

# Run build & watch for changes
$ yarn dev
```

Now you can edit `/assets/css/` files, which will be compiled to `/assets/built/` automatically.

The `zip` Gulp task packages the theme files into `dist/.zip`, which you can then upload to your site.

```bash
yarn zip
```

# PostCSS Features Used

- Autoprefixer - Don't worry about writing browser prefixes of any kind, it's all done automatically with support for the latest 2 major versions of every browser.
- Variables - Simple pure CSS variables
- [Color Function](https://github.com/postcss/postcss-color-function)