SDWebImage documentation

SDWebImage Documentation https://sdwebimage.github.io

This repository hosts the in source documentation for SDWebImage. You can view this at sdwebimage.github.io.

Maintenance

The documentation is auto-generated using Jazzy.

Install jazzy

[sudo] gem install jazzy

Generate the SDWebImage documentation

jazzy \
  --objc \
  --author SDWebImage \
  --github_url https://github.com/rs/SDWebImage \
  --github-file-prefix https://github.com/rs/SDWebImage/tree/4.4.2 \
  --module-version 4.4.2 \
  --umbrella-header WebImage/SDWebImage.h \
  --documentation=Docs/\*.md \
  --module SDWebImage \
  --framework-root . \
  --output ../sdwebimage.github.io

(assuming SDWebImage and sdwebimage.github.io live in the same folder)