https://github.com/DoccZz/servedocc

A small Swift tool/server to serve DocC archives to your browser
https://github.com/DoccZz/servedocc

docc swift

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/DoccZz/servedocc
• Owner: DoccZz
• License: apache-2.0
• Created: 2021-06-30T20:39:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-02T13:15:57.000Z (over 3 years ago)
• Last Synced: 2024-07-09T05:42:18.712Z (4 months ago)
• Topics: docc, swift
• Language: Swift
• Homepage:
• Size: 10.7 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
servedocc

  



Small Swift script to serve "DocC" archives, a format to document Swift frameworks

and packages:

[Documenting a Swift Framework or Package](https://developer.apple.com/documentation/Xcode/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](https://github.com/mxcl/swift-sh) script

(install using a simple `brew install mxcl/made/swift-sh`),

from within Xcode or via `swift run`.

### Via swift-sh

Example:

```bash

$ cd Sources/servedocc

$ ./main.swift ~/Downloads/SlothCreator.doccarchive

```

### Who

**servedocc** is brought to you by

the

[Always Right Institute](http://www.alwaysrightinstitute.com)

and

[ZeeZide](http://zeezide.de).

We like 

[feedback](https://twitter.com/ar_institute), 

GitHub stars, 

cool [contract work](http://zeezide.com/en/services/services.html),

presumably any form of praise you can think of.