https://github.com/royalfig/ghost-theme-starter

A starter template for creating a custom Ghost theme
https://github.com/royalfig/ghost-theme-starter

ghost ghost-theme

Last synced: 3 months ago
JSON representation

A starter template for creating a custom Ghost theme

• Host: GitHub
• URL: https://github.com/royalfig/ghost-theme-starter
• Owner: royalfig
• Created: 2021-12-30T19:36:45.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-18T21:14:23.000Z (over 1 year ago)
• Last Synced: 2023-08-18T22:43:58.000Z (over 1 year ago)
• Topics: ghost, ghost-theme
• Language: JavaScript
• Homepage:
• Size: 313 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ghost Starter Theme

- To get started, click `Use this template` and clone the repo

- CD into the directory

```bash

npm install

```

- Make a symlink from the theme directory to your local install of Ghost's themes folder 

``` bash

# /content/themes

ln -s ~/your-theme-folder .

```

- Restart ghost (`ghost restart`)

## Dev Script

```bash

# Start the live reload server and compile your JS/CSS assets, and watch for changes

npm run dev

```

If your site isn't refreshing, you'll likely need to disable your browser's caching. Go to the Network tab in your dev tools and toggle "Disable cache".

## Production Scripts

```bash

# Fix any CSS issues, compile your JS/CSS assets for production, and create a ZIP file

npm run zip

# Scan your theme for potential incompatibilties with gscan

npm run check

```