Skip to content

Commit 7e6d434

Browse files
Fix Broken Documentation Links (CodeEditApp#342)
Fix some broken links, specifically linking to the doc file for the source editor struct and fixing the homepage for the documentation site.
1 parent a7a181f commit 7e6d434

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ Licensed under the [MIT license](https://github.com/CodeEditApp/CodeEdit/blob/ma
3434

3535
### Text View
3636

37+
<<<<<<< chore/docs
38+
- <doc:SourceEditor> The SwiftUI API for the source editor.
39+
=======
3740
- ``SourceEditor`` The SwiftUI API for the source editor.
41+
>>>>>>> main
3842
- ``SourceEditorConfiguration`` Customize the source editor's behavior, layout, appearance, and more.
3943
- ``SourceEditorState`` Listen to the current state of the editor. Cursor positions, scroll positions, and more.
4044
- ``TextViewController`` The AppKit view controller for the source editor.

Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ``SourceEditor``
1+
# Source Editor
22

33
## Usage
44

Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ import AppKit
3131
/// - The category initializer.
3232
/// - The passthrough variable in `TextViewController`.
3333

34-
/// Configuration object for the ``SourceEditor``. Determines appearance, behavior, layout and what features are
34+
/// Configuration object for the <doc:SourceEditor>. Determines appearance, behavior, layout and what features are
3535
/// enabled (peripherals).
3636
///
3737
/// To update the configuration, update the ``TextViewController/configuration`` property, or pass a value to the
38-
/// ``SourceEditor`` SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will
38+
/// <doc:SourceEditor> SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will
3939
/// update the text controller as necessary for the new configuration.
4040
public struct SourceEditorConfiguration: Equatable {
4141
/// Configure the appearance of the editor. Font, theme, line height, etc.

Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77

88
import AppKit
99

10-
/// A protocol that can be used to receive extra state change messages from ``SourceEditor``.
10+
/// A protocol that can be used to receive extra state change messages from <doc:SourceEditor>.
1111
///
1212
/// These are used as a way to push messages up from underlying components into SwiftUI land without requiring passing
13-
/// callbacks for each message to the ``SourceEditor`` initializer.
13+
/// callbacks for each message to the
14+
/// ``SourceEditor/init(_:language:configuration:state:highlightProviders:undoManager:coordinators:)`` initializer.
1415
///
1516
/// They're very useful for updating UI that is directly related to the state of the editor, such as the current
1617
/// cursor position. For an example, see the ``CombineCoordinator`` class, which implements combine publishers for the

0 commit comments

Comments
 (0)