Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/imaginarymachines/pmsite-docs/archive/refs/heads/main.zipNo built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
Installation
- Git clone:
git clone git@github.com:imaginary-machines/pmsite-docs.git
- Install javascript dependencies
yarn
Working With JavaScript
- Build JS/CSS
yarn build
- Start JS/CSS for development
yarn start
- Test changed files
yarn test --watch
- Test all files once
yarn testyarn test --ci
Local Development Environment
A docker-compose-based local development environment is provided.
- Start server
docker-compose up -d
- Acess Site
- Run WP CLI command:
docker-compose run wpcli wp user create admin admin@example.com --role=admin user_pass=pass