/audiokit.io

Website for AudioKit documentation.

Primary LanguageSwiftMIT LicenseMIT

AudioKit.io

CI Status License

audiokit.io hosts DocC documentation for all AudioKit packages.

Running the Website

The first and only thing we need to do is add a working directory to our schemes to enable file middleware:

Configure your working directory.

You can run the website by hitting Run in Xcode or via swift run Run in the terminal.

Adding Documentation

  1. Follow the instructions in audiokit/docgen. Make sure your changes are committed and pushed.
  2. Run scripts/docgen.sh in this repository.
  3. Commit and push your changes.

The site will automatically re-deploy to both development and production environments.