-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add api documentation by using swifts docc (#94)
* Bump the minimum swift version to 5.6 * Add swifts docc to document the api * Remove the old instructions * Add articles to the documentation catalog * Add a manifest file for swiftpackageindex * Remove script files
- Loading branch information
1 parent
4167857
commit 92b5602
Showing
21 changed files
with
100 additions
and
286 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
version: 1 | ||
builder: | ||
configs: | ||
- documentation_targets: [HTMLKit] |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
24 changes: 0 additions & 24 deletions
24
Instructions/Example/Page/Controllers/SimpleController.swift
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
42 changes: 42 additions & 0 deletions
42
Sources/HTMLKit/Documentation.docc/Essentials/Getting_started.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Getting started | ||
|
||
Learn how to use it. | ||
|
||
### Requirements | ||
|
||
HTMLKit requires Swift 5.6 or higher. | ||
|
||
### Installation | ||
|
||
To use HTMLKit in your project, you have to add the package as dependency to your package description first. Be sure to add it as your desired targets as well. | ||
|
||
```swift | ||
let package = Package( | ||
... | ||
dependencies: [ | ||
// 1. Add the package | ||
.package(url: "https://github.com/vapor-community/HTMLKit.git", from: "2.6.0"), | ||
], | ||
targets: [ | ||
.target( | ||
... | ||
dependencies: [ | ||
/// 2. Add the product | ||
.product(name: "HTMLKit", package: "HTMLKit"), | ||
] | ||
), | ||
... | ||
] | ||
) | ||
``` | ||
|
||
From time to time you want to update the package. You can do it, by changing the version tag manually and saving it. You find the current version tag in the [release history](https://github.com/vapor-community/HTMLKit/releases). We recommand to read the release description first, to understand the possible changes. | ||
|
||
### Usage | ||
|
||
Use the import keyword to load the module in your project files. | ||
|
||
```swift | ||
import HTMLKit | ||
... | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.