Mantle is a bedrock-inspired, imposer and postmark-based, composer-oriented, docker-compose runtime environment for Wordpress development, built on doco, .devkit, and dirtsimple/php-server.
In addition to being a convenient template for Wordpress projects, Mantle is designed to work with imposer and postmark, automatically running imposer apply at container start to apply Wordpress configuration from your project source and environment variables, and wp postmark tree content to sync Wordpress content from Markdown files with YAML front matter.
(You can also manually run these commands to sync files at other times, or run script/watch to watch them for changes and apply them to the development DB.)
State modules are Markdown documents (*.state.md files) that contain blocks of bash, jq, or PHP code, along with YAML or JSON data. The PHP code embedded in the relevant state files is run using wp-cli, so state file code fragments have full access to the Wordpress API.
State modules are a bit like database "migrations" or Drupal "features", allowing you to expose Wordpress configuration in documented, revision-controlled files, instead of having values appear only inside various database tables.
For example, you can define a state module that reads various API keys from the container's environment and then tweaks Wordpress option values to use those keys instead of whatever was in the database before. Or you can define modules that ensure specific plugins are installed or activated or deactivated, specific menus exist, etc. (State modules can even include php tweak code snippets that get automatically combined automatically into a custom plugin, without needing to edit a theme's functions.php!)
See the imposer documentation for more details.
Any *.md files in the project's content/ directory (or any subdirectory thereof) are automatically synced to create Wordpress posts or pages, converting Markdown to HTML for the post body, and using YAML front matter to set metadata like tags, dates, etc. See the postmark documentation for more details, and/or wp help postmark.
To run Mantle, you'll need git, docker, jq 1.5+, and docker-compose, on a machine with bash 4. (direnv is also highly recommended, but not strictly required: without it, you'll need to manually source the .envrc in your project directory to be able to access the doco and dk tools, among others.)
To begin using it, simply:
$ git clone https://github.com/dirtsimple/mantle myproject
$ cd myproject
$ script/setupThis will initialize the project, creating myproject/.env and various myproject/deploy/*.env files. Review and edit these files to make sure that things are configured to your needs.
The most critical settings are in the main myproject/.env file, where you will need to:
- Set the URLs for your dev, stage, and prod environments
- Determine how those URLs will be routed to their containers (e.g. via port mapping, or a reverse proxy such as jwilder/nginx-proxy or Traefik), and
- Decide whether you'll be using a project-specific mysql server (the default), or a shared one
Once you've configured your project, you can then:
$ doco dev dba mkuser # make a dev user w/generated password and db access
$ doco dev up -d # create and start the dev container(Note: if you're not using direnv and don't have doco installed globally, you'll need to source .envrc in a subshell to add project tools like doco to your PATH. This will also override wp and composer with scripts that run those commands inside the development container, i.e. by aliasing them to doco wp and doco composer.)
This project is in active development and lacks end-user documentation other than this file. For developer documentation, see the Configuration, Commands, state modules and content files docs, along with the Mantle state file.