https://github.com/apple/swift-docc-symbolkit

A Swift package for encoding and decoding Swift Symbol Graph files.
https://github.com/apple/swift-docc-symbolkit

Last synced: 3 months ago
JSON representation

A Swift package for encoding and decoding Swift Symbol Graph files.

• Host: GitHub
• URL: https://github.com/apple/swift-docc-symbolkit
• Owner: apple
• License: apache-2.0
• Created: 2021-07-19T16:45:53.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-06T11:13:31.000Z (4 months ago)
• Last Synced: 2024-03-06T18:08:17.946Z (4 months ago)
• Language: Swift
• Homepage: https://apple.github.io/swift-docc-symbolkit/documentation/symbolkit
• Size: 740 KB
• Stars: 162
• Watchers: 103
• Forks: 34
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• awesome-stars - apple/swift-docc-symbolkit - A Swift package for encoding and decoding Swift Symbol Graph files. (Swift)
• awesome-stars - apple/swift-docc-symbolkit - A Swift package for encoding and decoding Swift Symbol Graph files. (Swift)

README

        
# SymbolKit 

The specification and reference model for the *Symbol Graph* File Format.

A *Symbol Graph* models a *module*, also known in various programming languages as a "framework", "library", or "package", as a [directed graph](https://en.wikipedia.org/wiki/Directed_graph). In this graph, the nodes are declarations, and the edges connecting nodes are relationships between declarations.

By modeling different kinds of relationships, SymbolKit can provide rich data to power documentation, answering interesting questions, such as:

- *Which types conform to this protocol?*

- *What is the class hierarchy rooted at this class?*

- *Which protocol provides a requirement called `count`?*

- *Which types customize this protocol requirement?*

In addition, graph representations of data also present opportunities for visualizations in documentation, illustrating the structure or hierarchy of a module.

Please see SymbolKit's [documentation site](https://apple.github.io/swift-docc-symbolkit/documentation/symbolkit/) for more detailed information about the library.

## Getting Started Using SymbolKit

In your `Package.swift` Swift Package Manager manifest, add the following dependency to your `dependencies` argument:

```swift

.package(url: "https://github.com/apple/swift-docc-symbolkit.git", .branch("main")),

```

Add the dependency to any targets you've declared in your manifest:

```swift

.target(name: "MyTarget", dependencies: ["SymbolKit"]),

```