passle-sync-wordpress-demo-theme
Passle Sync Demo Theme for WordPress
Passle Sync Demo is a theme for WordPress which makes use of the Passle Sync plugin.
π Getting started
This theme is intended to serve as an example of how to use the Passle Sync plugin in your theme templates. To get started, take a look at the templates for the custom post types that the plugin creates, single-passle-post.php, and single-passle-author.php.
These templates are pretty standard β the important thing is that they are named correctly, as described in the WordPress documentation. The interesting stuff all happens in the template parts, content-single-passle-post.php, and content-single-passle-author.php.
For more info on how to use the Passle Sync plugin, view the API documentation in the pluginβs repository.
π§ Requirements
TBD
π¨βπ» Development
Prerequisites
- NPM
- Development environment running a WordPress instance
Environment setup
To develop this theme, first clone the repository:
git clone https://github.com/passle/passle-sync-wordpress-demo-theme
Next, install all dependencies and build the frontend with the following commands:
npm install
npm run init
Developing the frontend
To develop the frontend, use the watch
script available in package.json.
Building the theme zip
To build the theme zip file, use the build
script available in package.json. This will install all dependencies, build the frontend, and create a zip containing all necessary output files.
π¬ Contributing
If youβd like to request a feature or report a bug, please create a GitHub Issue.
π License
The Passle Sync demo theme is released under the under terms of the MIT License.