Skip to content

Commit

Permalink
Upgrade the package (#140)
Browse files Browse the repository at this point in the history
* Bump the swift tools version

* Remove toggle documentation reference

* Add documentation attribute to change the visibility of some symbols

* Bump swift version for the hosted runner

* Restructure the documentation catalog

* Add a documentation tutorial

* Fix redudant declaration

* Add documentation attribute to the recently added attributes

* Start the localization tutorial

* Add recently added elements to the element list

* Work on the page structure for the tutorials

* Bump swift docc plugin version

* Work on the content

* Work on the content

* Update readme and correct some grammar

* Revise the sentence to prevent line break for better reading

* Make wee changes to the documenation
  • Loading branch information
mattesmohr authored Jan 30, 2024
1 parent 5987966 commit bad6dbe
Show file tree
Hide file tree
Showing 114 changed files with 1,169 additions and 250 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
jobs:
test-pushpull:
runs-on: ubuntu-latest
container: swift:5.7-focal
container: swift:5.8-focal
steps:
- uses: actions/checkout@v3
- name: Run tests
Expand Down
4 changes: 2 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// swift-tools-version:5.7
// swift-tools-version:5.8

import PackageDescription

Expand All @@ -23,7 +23,7 @@ let package = Package(
],
dependencies: [
.package(url: "https://github.com/apple/swift-collections.git", from: "1.0.1"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
.package(url: "https://github.com/vapor/vapor.git", from: "4.65.2")
],
targets: [
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,15 @@
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvapor-community%2FHTMLKit%2Fbadge%3Ftype%3Dplatforms" alt="platforms" />
</a>
</div>
<br>

The HTMLKit framework consists of a list of features to create HTML templates in a type-safe and performant way:

- **Declarative syntax** - The declarative syntax helps you write valid HTML markup.
- **Template system** - Scaffold your code into various, reusable views to create an entire template.
- **Dynamic context** - Apply context to your template to process content dynamically.
- **Language localization** - Specify the parts that should be translated or formatted for local languages and cultures.
- **UI components** - Construct user interfaces with the components library.
- **Symbol bundle** - Use the symbols which come within the framework.

The framework comes with an integration for the web framework [Vapor](https://swiftpackageindex.com/vapor/vapor). Interested? Lets get started: [Tutorials](https://swiftpackageindex.com/vapor-community/HTMLKit/3.0.0-alpha.8/documentation/htmlkit)
Loading

0 comments on commit bad6dbe

Please sign in to comment.