WooCommerce Memberships REST API documentation

Official repository for the documentation of the WooCommerce Memberships REST API.

Follow this link to read the REST API documentation.

If you are looking for the general plugin documentation, please follow this link.

Contributing

You can contribute to this documentation by:

• Opening an issue to report a problem or information missing, etc.
• Opening a pull request to extend the documentation.

Please do not submit feature requests or support requests for the REST API here. You can use the WooIdeas board or Contact SkyVerge support.

Running locally

Natively

bundle install

Important note: if you run into bundle install errors, you may need to install ruby-devel and install the related gems again to build native extensions.

Then, to test changes locally run:

bundle exec middleman server

Via Docker

1. Build the docker image:

   docker build . -t docs

2. Start the image:

   docker run -d --rm --name docs -p 4567:4567 -v $(pwd)/build:/srv/docs/build -v $(pwd)/source:/srv/docs/source docs

You will be able to access your site at http://localhost:4567.

To build your sources while the container is running, run:

docker exec -it docs /bin/bash -c "bundle exec middleman build"

Updating pages

This project uses Slate for building the documentation pages.

Follow Slate readme and wiki for instructions on how to edit files and make changes.

Deploying an update

GitHub Action

A deploy GitHub action is triggered automatically when changes are pushed to main or master branches. No manual action is normally required.

Deploy script

If the GitHub action fails, after pushing changes, you can deploy using the script:

bash deploy.sh