Musille

Musille is a WordPress theme used by the LJO Hamburg.

Installation

Go to Releases and downlaod the latest version of the theme. Install it via the WordPress admin. If you are usure how to install the theme see this help page for more information.

The theme supports auto update functionality via Plugin Update Checker. This functionality is enabled by default.

Note: This theme requires at least PHP 7.4.

Comments

The Musille theme does not support comments. Although it does nothing to prevent wordpress from using comment functionality, neither comments nor a comment form are included in the theme at the moment.

It is recommended that you use a plugin such as Disable Comments to completely hide the comments functionality from your site.

Development

Installing the Dependencies

In order to develop the theme you need Node.js and Composer. You also need Gnu gettext to compile translations. To get startet run the following commands:

npm install
composer install

This will install all dependencies required to build the theme.

Building the Theme

The theme provides several npm scripts that can be used to accomplish common tasks. Building the theme is as easy as

npm run build

This will simply execute gulp which is used as a build system. By default Gulp will compile the theme into a build folder. You can change the build director by providing a --dest argument like so:

npm run build -- --dest=dist

The additional -- is required to tell npm to pass the --dest argument to the build script.

The command above will compile a production version of the theme. In development you likely want additional features (such as the development autoloader). To compile the theme for development run

npm run build-dev

The theme will be built into the build folder (which can be overridded using --dest as above). The build folder can then be mounted inside a docker container or VM or be symlinked to a WordPress installation in the themes folder.

In development you can automatically recompile if you change a file. To do so run

npm run watch

This will watch most of the development files and recompile them if any changes are detected. Note that the dependencies in composer.json and package.json are not watched. If you change any of those you need to manually trigger a rebuild using npm run build-dev. The --dest arguments works with this task as well.

The build directory is not automatically cleaned. Existing files are overridden but orphaned files are not deleted. If you want to clean the build directory just run

npm run clean

Creating Translations

The Theme is completely translation-ready. Translations are compiled from the languages folder automatically. If you want to add a new translatable strings be sure to run

npm run gettext

afterwards to update the translation files to reflect the updated code. Note that the gettext utility needs to be installed separately.

Linting the Code

To check the code for style violations run

npm run lint

Alternatively you can lint only a part of the code using one of the following:

npm run lint:php
npm run lint:js
npm run lint:scss