- To get started, click
Use this template
and clone the repo - CD into the directory
npm install
- Make a symlink from the theme directory to your local install of Ghost's themes folder
# /content/themes
ln -s ~/your-theme-folder .
- Restart ghost (
ghost restart
)
# 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".
# 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