Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danielsaidi committed Mar 6, 2024
1 parent ca2f70e commit 99d4306
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ RichTextKit can be installed with the Swift Package Manager:
https://github.com/danielsaidi/RichTextKit.git
```

If you prefer to not have external dependencies, you can also just copy the source code into your app.



## Getting started
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This article describes how to use the ``RichTextContext`` to observe and modify
The ``RichTextContext`` is at the heart of the ``RichTextEditor``. It can be used to observe and modify the rich text in the editor and to trigger rich text-specific ``RichTextAction``s and other functions.



## How to observe context changes

When you move the text cursor around in a ``RichTextEditor``, its ``RichTextCoordinator`` will sync the ``RichTextContext`` with the current state of the editor.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ RichTextKit has a multi-platform demo app that show how to use the library on mu
The demo app can be explored from the [GitHub repository][GitHub]. It's a document-based app that runs on both macOS, iOS, and iPadOS and persists rich text files on disc.



## How to run the demo on device

The demo app has disabled code signing, to simplify its setup.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ For instance, the ``RichTextAction``-specific ``RichTextAction/Button``, ``RichT
There are also type-specific views, like the ``RichTextAlignment``-specific ``RichTextAlignment/Picker``, which can be used to pick a rich text alignment.



## Available views

Below is a list of available views, grouped by purpose and listed by namespace.
Expand Down Expand Up @@ -157,6 +158,7 @@ Below is a list of available views, grouped by purpose and listed by namespace.
}



## Styling & Configuration

Many of the RichTextKit views can be styled and configured with view modifiers, that can be applied anywhere in your view hierarchy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This article describes how to get started using RichTextKit.
RichTextKit is a Swift-based library that lets you work with rich text in UIKit, AppKit and SwiftUI. This article describes how to get started using RichTextKit in both SwiftUI, UIKit and AppKit.



## Getting started with SwiftUI

RichTextKit has a multi-platform SwiftUI ``RichTextEditor`` that can be added to any app:
Expand Down

0 comments on commit 99d4306

Please sign in to comment.