Skip to content

Commit

Permalink
Merge pull request #64 from arshad-yaseen/improve-doc-toc
Browse files Browse the repository at this point in the history
Improve Doc Toc
  • Loading branch information
arshad-yaseen authored Oct 25, 2024
2 parents afbfa54 + bc520e8 commit 45f91d0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 17 deletions.
11 changes: 1 addition & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@


## [0.12.5](https://github.com/arshad-yaseen/monacopilot/compare/v0.12.4...v0.12.5) (2024-10-25)


### 📚 Documentation

* improve toc ([9353ac2](https://github.com/arshad-yaseen/monacopilot/commit/9353ac22f66af2819b04bd369b38980d88f9a81b))

<<<<<<< Updated upstream
- improve toc ([9353ac2](https://github.com/arshad-yaseen/monacopilot/commit/9353ac22f66af2819b04bd369b38980d88f9a81b))

## [0.12.4](https://github.com/arshad-yaseen/monacopilot/compare/v0.12.3...v0.12.4) (2024-10-24)

### 🔧 Maintenance

- improved logger logic ([cc71782](https://github.com/arshad-yaseen/monacopilot/commit/cc7178270f555abe1a9c21f92386aef3540d020d))

=======

> > > > > > > Stashed changes
## [0.12.3](https://github.com/arshad-yaseen/monacopilot/compare/v0.12.2...v0.12.3) (2024-10-23)

### 🐛 Bug Fixes
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@
- [Register Completion with the Monaco Editor](#register-completion-with-the-monaco-editor)
- [Register Completion Options](#register-completion-options)
- [Trigger Mode](#trigger-mode)
- [Get Completions in Real-Time](#get-completions-in-real-time)
- [Manually Trigger Completions](#manually-trigger-completions)
- [Trigger Completions with a Keyboard Shortcut](#trigger-completions-with-a-keyboard-shortcut)
- [Trigger Completions with an Editor Action](#trigger-completions-with-an-editor-action)
- [Manually Trigger Completions](#manually-trigger-completions)
- [Trigger Completions with a Keyboard Shortcut](#trigger-completions-with-a-keyboard-shortcut)
- [Trigger Completions with an Editor Action](#trigger-completions-with-an-editor-action)
- [Multi-File Context](#multi-file-context)
- [Filename](#filename)
- [Completions for Specific Technologies](#completions-for-specific-technologies)
Expand Down Expand Up @@ -168,7 +167,7 @@ registerCompletion(monaco, editor, {

> **Note:** If you prefer real-time completions, you can set the `trigger` option to `'onTyping'`. This may increase the number of requests made to the provider and the cost. This should not be too costly since most small models are very inexpensive.
#### Manually Trigger Completions
### Manually Trigger Completions

If you prefer not to trigger completions automatically (e.g., on typing or on idle), you can trigger completions manually. This is useful in scenarios where you want to control when completions are provided, such as through a button click or a keyboard shortcut.

Expand All @@ -182,7 +181,7 @@ completion.trigger();

To set up manual triggering, configure the `trigger` option to `'onDemand'`. This disables automatic completions, allowing you to call the `completion.trigger()` method explicitly when needed.

##### Trigger Completions with a Keyboard Shortcut
#### Trigger Completions with a Keyboard Shortcut

You can set up completions to trigger when the `Ctrl+Shift+Space` keyboard shortcut is pressed.

Expand All @@ -199,7 +198,7 @@ monaco.editor.addCommand(
);
```

##### Trigger Completions with an Editor Action
#### Trigger Completions with an Editor Action

You can add a custom editor action to trigger completions manually.

Expand Down

0 comments on commit 45f91d0

Please sign in to comment.