winter/wn-workshop-theme

TailwindCSS-built theme for testing core plugins

dev-main 2024-04-08 01:43 UTC

Requires

• composer/installers: ~1.0

MIT

• Ben Thomson
• Winter CMS Maintainers

• testing
• plugin
• theme
• workshop
• winter
• winter cms

README

The Workshop Theme is a simple theme built on Tailwind CSS that aims to be a testbed for the core Winter CMS plugins.

The theme tests the following plugins:

• Static Pages
• Blog
• Forum
• User
• Translate
• Sitemap

And tests the following concepts:

• The Snowboard JavaScript framework
• Inline component code
• Theme-based component template overrides

Requirements

• Winter CMS 1.1.8 or above.
• NodeJS 12 or above, if you wish to style the theme.

Development

The theme is built on Tailwind CSS, which is built using the NodeJS framework. To be able to compile any changes made to the styling or content, you must use the Mix commands that are included with Winter CMS 1.1.8.

You must first install the Node dependencies required for the theme.

php artisan mix:install -p theme-workshop

Then, to compile the Tailwind CSS styles for development, run the following command in the root folder of the project:

php artisan mix:compile -p theme-workshop

To compile the Tailwind CSS styles for production (which should be done if you commit any changes to the Workshop theme), you must add the --production flag to the above command:

php artisan mix:compile -p theme-workshop --production

To make it easy to develop the theme, you can also watch the necessary template and stylesheet files for any changes:

php artisan mix:watch theme-workshop