Skip to content

Clean Up Documentation Site #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2025
Merged

Clean Up Documentation Site #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,12 @@ Licensed under the [MIT license](https://github.com/CodeEditApp/CodeEdit/blob/ma

### Text View

<<<<<<< chore/docs
- <doc:SourceEditor> The SwiftUI API for the source editor.
=======
- ``SourceEditor`` The SwiftUI API for the source editor.
>>>>>>> main
- ``SourceEditorConfiguration`` Customize the source editor's behavior, layout, appearance, and more.
- ``SourceEditorState`` Listen to the current state of the editor. Cursor positions, scroll positions, and more.
- ``TextViewController`` The AppKit view controller for the source editor.
- ``GutterView`` A view used to display line numbers and folding regions.
- <doc:SourceEditorView>
- ``SourceEditor``
- ``SourceEditorConfiguration``
- ``SourceEditorState``
- ``TextViewController``
- ``GutterView``

### Themes

Expand Down
5 changes: 4 additions & 1 deletion ...Editor/Documentation.docc/SourceEditor.md → ...or/Documentation.docc/SourceEditorView.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Source Editor
# Source Editor View

## Usage

Expand Down Expand Up @@ -90,3 +90,6 @@ let editorController = TextViewController(
)
```

## Topics

- ``SourceEditor``
4 changes: 2 additions & 2 deletions Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ import AppKit
/// - The category initializer.
/// - The passthrough variable in `TextViewController`.

/// Configuration object for the <doc:SourceEditor>. Determines appearance, behavior, layout and what features are
/// Configuration object for the <doc:SourceEditorView>. Determines appearance, behavior, layout and what features are
/// enabled (peripherals).
///
/// To update the configuration, update the ``TextViewController/configuration`` property, or pass a value to the
/// <doc:SourceEditor> SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will
/// <doc:SourceEditorView> SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will
/// update the text controller as necessary for the new configuration.
public struct SourceEditorConfiguration: Equatable {
/// Configure the appearance of the editor. Font, theme, line height, etc.
Expand Down
2 changes: 1 addition & 1 deletion Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import AppKit

/// A protocol that can be used to receive extra state change messages from <doc:SourceEditor>.
/// A protocol that can be used to receive extra state change messages from <doc:SourceEditorView>.
///
/// These are used as a way to push messages up from underlying components into SwiftUI land without requiring passing
/// callbacks for each message to the
Expand Down