Skip to content

A small Swift tool/server to serve DocC archives to your browser

License

Notifications You must be signed in to change notification settings

DoccZz/servedocc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

servedocc

Small Swift script to serve "DocC" archives, a format to document Swift frameworks and packages: Documenting a Swift Framework or Package.

Note: This is for serving an exported documentation archive (.doccarchive), not for building documentation from a DocC catalog.

Usage

The server can be either run as a swift-sh script (install using a simple brew install mxcl/made/swift-sh), from within Xcode or via swift run.

Via swift-sh

Example:

$ cd Sources/servedocc
$ ./main.swift ~/Downloads/SlothCreator.doccarchive

Who

servedocc is brought to you by the Always Right Institute and ZeeZide. We like feedback, GitHub stars, cool contract work, presumably any form of praise you can think of.