This commit is contained in:
26
Examples/README.md
Normal file
26
Examples/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# swift-cli-doc
|
||||
|
||||
A tool for building rich documentation for command line applications using result builders and
|
||||
syntax similar to `SwiftUI`.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Add this as a package dependency to your command line application.
|
||||
|
||||
```swift
|
||||
let package = Package(
|
||||
name: "my-tool"
|
||||
...
|
||||
dependencies: [
|
||||
.package(url: "https://git.housh.dev/michael/swift-cli-doc", from: "0.1.0")
|
||||
],
|
||||
targets: [
|
||||
.executableTarget(
|
||||
name: "my-tool",
|
||||
dependencies: [
|
||||
.product(name: "CliDoc", package: "swift-cli-doc")
|
||||
]
|
||||
)
|
||||
]
|
||||
)
|
||||
```
|
||||
@@ -9,7 +9,8 @@ struct Application: ParsableCommand {
|
||||
subcommands: [
|
||||
SectionCommand.self,
|
||||
VStackCommand.self,
|
||||
HStackCommand.self
|
||||
HStackCommand.self,
|
||||
GroupCommand.self
|
||||
]
|
||||
)
|
||||
}
|
||||
|
||||
21
Examples/Sources/CliDoc-Examples/GroupCommand.swift
Normal file
21
Examples/Sources/CliDoc-Examples/GroupCommand.swift
Normal file
@@ -0,0 +1,21 @@
|
||||
import ArgumentParser
|
||||
import CliDocCore
|
||||
|
||||
struct GroupCommand: ParsableCommand {
|
||||
|
||||
static let configuration = CommandConfiguration(commandName: "group")
|
||||
|
||||
func run() throws {
|
||||
let group = Group {
|
||||
"My headline."
|
||||
"\n"
|
||||
"Some content".color(.green)
|
||||
"\n"
|
||||
"Foo Bar".italic()
|
||||
}
|
||||
.color(.blue)
|
||||
|
||||
print()
|
||||
print("\(group.render())")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user