Docs site for the deprecated CharityBase v4 REST API.
The v4 API will stop working in Q3 2019. Please migrate to the GraphQL API, documented at charitybase.uk/api-portal.
This section is only useful for people developing the documentation (e.g. making a correction to submit by pull request).
You're going to need:
- Linux or macOS โ Windows may work, but is unsupported.
- Ruby, version 2.3.1 or newer
- Bundler โ If Ruby is already installed, but the
bundle
command doesn't work, just rungem install bundler
in a terminal.
# Run locally:
bundle install
bundle exec middleman server
# Or with vagrant:
vagrant up
You can now see the docs at http://localhost:4567
Create a production build:
bundle exec middleman build --clean
Deploy build
with Now:
now && now alias
These docs were generated using Slate.