Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.26 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.26 KB
Raw

Ghost Themes

A monorepo for Ghost official themes.

Development

You'll need Node, Yarn and Gulp installed globally. After that, from the project's root directory:

# install dependencies
yarn

# run development server
yarn dev

Now you can edit files in packages/<theme-name>/assets/css/ or packages/<theme-name>/assets/js/, which will be compiled to packages/<theme-name>/assets/built/ automatically.

To run a theme locally, you need to symlink a theme to your local Ghost site.

# run a theme locally
yarn symlink --theme <theme-name> --site /dir/to/your/ghost-site

If you're running the Ghost monorepo:

yarn symlink --theme <theme-name> --site /dir/to/Ghost/ghost/core

Or if you're running a Ghost instance via the CLI:

yarn symlink --theme <theme-name> --site /dir/to/ghost-instance

Restart your Ghost instance and the theme will be listed in the Design settings.

To create an installable theme zip file in packages/<theme-name>/dist/:

# create .zip file
yarn zip --theme <theme-name>

Copyright & License

Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.