Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.03 KB

README.md

File metadata and controls

32 lines (24 loc) · 1.03 KB
Raw

CocoaLumberjack documentation

CocoaLumberjack Documentation https://cocoaLumberjack.github.io

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

Maintenance

The documentation is auto-generated using Jazzy.

Install jazzy

[sudo] gem install jazzy

Generate the CocoaLumberjack documentation

jazzy \
  --objc \
  --author CocoaLumberjack \
  --github_url https://github.com/CocoaLumberjack/CocoaLumberjack \
  --github-file-prefix https://github.com/CocoaLumberjack/CocoaLumberjack/tree/3.6.1 \
  --module-version 3.6.1 \
  --umbrella-header Sources/CocoaLumberjack/Supporting\ Files/CocoaLumberjack.h \
  --documentation=Documentation/\*.md \
  --module CocoaLumberjack \
  --output ../cocoaLumberjack.github.io \
  --framework-root Sources

(assuming CocoaLumberjack and cocoaLumberjack.github.io live in the same folder)