fix: opti some readme #36
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for tisqleditor-playground ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
baurine
reviewed
Jun 28, 2024
README.md
Outdated
| @@ -21,20 +21,21 @@ https://github.com/tidbcloud/tisqleditor/assets/1284531/732b600f-5b4e-45d3-a3d2- | |||
|
|
|||
| ## Packages | |||
|
|
|||
| All the extensions as below: | |||
There was a problem hiding this comment.
@tidbcloud/tisqleditor and @tidbcloud/tisqleditor-react are not extensions.
baurine
reviewed
Jun 28, 2024
| | package | desc | | ||
| | ---------------------------------------------- | ------------------------------------------------------------------------- | | ||
| | @tidbcloud/tisqleditor | SQLEditorInstance with pre-configured extensions | | ||
| | @tidbcloud/tisqleditor-react | React component wrapper | | ||
| | @tidbcloud/codemirror-extension-ai-widget | a widget to chat with AI to help write or refine SQL by human language | |
There was a problem hiding this comment.
This package should keep.
baurine
reviewed
Jun 28, 2024
README.md
Outdated
| | @tidbcloud/codemirror-extension-linters | | | ||
| | @tidbcloud/codemirror-extension-events | | | ||
| | @tidbcloud/codemirror-extension-autocomplete | SQL keyword and database schema autocomplete tips | | ||
| | @tidbcloud/codemirror-extension-linters | Full-width characters, regular expression, or use statements linter | |
There was a problem hiding this comment.
or ... -> and use statement linter
baurine
reviewed
Jun 28, 2024
packages/extensions/events/README.md
Outdated
Comment on lines
4
to
6
| onChange: any doc change will trigger this event | ||
| onFocusChange: while the cursor change will trigger this event | ||
| onSelectionChange: while selection content change will trigger this event |
There was a problem hiding this comment.
- onChnage: ...
- onFoucusChange: ...
- onSelectionChange: ...
baurine
force-pushed
the
feat/readme-opti
branch
from
d709a43 to
aa12d0a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.